Productboard

Learn how to use Productboard with Composio

Overview

SLUG: PRODUCTBOARD

Description

Productboard is a product management platform that gathers feedback, prioritizes features, and aligns roadmaps based on customer insights and strategic goals

Authentication Details

client_id
stringRequired
client_secret
stringRequired
full
stringDefaults to https://api.productboard.comRequired
oauth_redirect_uri
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to users:read
bearer_token
string
generic_api_key
stringRequired

Connecting to Productboard

Create an auth config

Use the dashboard to create an auth config for the Productboard toolkit. This allows you to connect multiple Productboard accounts to Composio for agents to use.

1

Select App

Navigate to Productboard.

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Productboard Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4productboard_auth_config_id = "ac_YOUR_PRODUCTBOARD_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11 connection_request = composio.connected_accounts.initiate(
12 user_id=user_id,
13 auth_config_id=auth_config_id,
14 )
15
16 print(
17 f"Visit this URL to authenticate Productboard: {connection_request.redirect_url}"
18 )
19
20 # This will wait for the auth flow to be completed
21 connection_request.wait_for_connection(timeout=15)
22 return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, productboard_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Using API Key

1from composio import Composio
2
3# Replace these with your actual values
4productboard_auth_config_id = "ac_YOUR_PRODUCTBOARD_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000" # UUID from database/app
6
7composio = Composio()
8
9def authenticate_toolkit(user_id: str, auth_config_id: str):
10 # Replace this with a method to retrieve an API key from the user.
11 # Or supply your own.
12 user_api_key = input("[!] Enter API key")
13
14 connection_request = composio.connected_accounts.initiate(
15 user_id=user_id,
16 auth_config_id=auth_config_id,
17 config={"auth_scheme": "API_KEY", "val": {"generic_api_key": user_api_key}}
18 )
19
20 # API Key authentication is immediate - no redirect needed
21 print(f"Successfully connected Productboard for user {user_id}")
22 print(f"Connection status: {connection_request.status}")
23
24 return connection_request.id
25
26
27connection_id = authenticate_toolkit(user_id, productboard_auth_config_id)
28
29# You can verify the connection using:
30connected_account = composio.connected_accounts.get(connection_id)
31print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the Productboard toolkit’s playground

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000" # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["PRODUCTBOARD"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17 completion = openai.chat.completions.create(
18 model="gpt-4o",
19 messages=[
20 {
21 "role": "user",
22 "content": task, # Your task here!
23 },
24 ],
25 tools=tools,
26 )
27
28 # Handle Result from tool call
29 result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30 print(f"[!] Completion: {completion}")
31 print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Note Followers

Description

Tool to add multiple followers to a Productboard note. Use when you need to bulk-add existing users as followers to a specific note by their email addresses.

Action Parameters

emails
arrayRequired
noteId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add Note Tag

Description

Tool to add a tag to a Productboard note. Use when categorizing a note after review; creates the tag if missing.

Action Parameters

noteId
stringRequired
tagName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Company in Productboard

Description

Tool to create a new company in Productboard. Use when you need to add a company record after gathering its details and optional metadata.

Action Parameters

description
string
domain
string
name
stringRequired
source
object

Action Response

data
objectRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: Create Company Custom Field

Description

Tool to create a new custom field for companies. Use when you need to define custom company attributes in Productboard after confirming the field schema.

Action Parameters

body
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Component

Description

Tool to create a new (sub)component under a product or component. Use after determining the parent component ID.

Action Parameters

data
objectRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Note

Description

Tool to create a new note in Productboard. Use when you need to programmatically add a user or customer note to Productboard.

Action Parameters

company
object
content
stringRequired
customer_email
string
display_url
string
source
object
tags
array
title
stringRequired
user
object

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Webhook Subscription

Description

Tool to create a new webhook subscription. Use when you need to register a public endpoint to receive webhooks from Productboard.

Action Parameters

events
array
name
string
notification_headers
object
notification_version
integer
url
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Company

Description

Tool to delete a specific company. Use when you have confirmed the company ID and need to remove it from Productboard.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Company Field

Description

Tool to delete a specific company custom field. Use after confirming the field ID and ensuring no dependencies remain.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Feature

Description

Tool to delete a specific feature. Use when you have confirmed the feature ID and deleted its subfeatures before removal.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Note

Description

Tool to delete a specific note. Use when you have confirmed the note ID and need to remove it from Productboard.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Note Tag

Description

Tool to remove a tag from a Productboard note. Use when you need to detach a specific tag from a note after tagging.

Action Parameters

noteId
stringRequired
tagName
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete User

Description

Tool to delete a specific user. Use when you have confirmed the user ID and need to remove it from Productboard.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Companies

Description

Tool to list companies. Use when you need a paginated list of companies with optional filters.

Action Parameters

featureId
string
hasNotes
string
pageLimit
integer
pageOffset
integer
term
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Company Custom Fields

Description

Tool to list company custom fields. Use when you need to retrieve all custom field definitions for companies after authentication.

Action Parameters

Action Response

data
arrayRequired
error
string
successful
booleanRequired

Tool Name: List Components

Description

Tool to list productboard components. Use when you need to retrieve components in a paginated form. Follow 'links.next' for additional pages.

Action Parameters

page_limit
integer
page_offset
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Custom Fields

Description

Tool to list custom field definitions for hierarchy entities. Use after determining which field types to filter.

Action Parameters

type
arrayRequired

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Custom Field Values

Description

Tool to list non-empty custom field values. Use when you need to fetch set values across custom fields with optional filtering by type or field ID. Paginate using links.next if more results exist.

Action Parameters

customField.id
string
hierarchyEntity.id
string
type
array

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Feature Initiatives

Description

Tool to list initiatives linked to a given feature. Use when you need to retrieve all initiatives associated with a feature after confirming its ID.

Action Parameters

id
stringRequired

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Feature Objectives

Description

Tool to list objectives linked to a feature. Use when you need to retrieve all objectives connected to a given feature after confirming the feature ID.

Action Parameters

id
stringRequired
pageCursor
string

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Feature Release Assignments

Description

Tool to list feature–release assignments. Use when you need to retrieve assignments for a specific feature or release with optional state or date filters; paginate using links.next.

Action Parameters

feature.id
string
release.id
string
release.state
string
release.timeframe.endDate.from
string
release.timeframe.endDate.to
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Features

Description

Tool to list features and subfeatures. Use when you need a paginated list of all features in Productboard.

Action Parameters

pageLimit
integer
pageOffset
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Feature Statuses

Description

Tool to list feature statuses. Use when you need to retrieve all feature status records in a paginated form. Follow 'links.next' for additional pages.

Action Parameters

next_page_url
string

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Feedback Form Configurations

Description

Tool to list feedback form configurations. Use when you need a paginated list of feedback form configurations.

Action Parameters

pageLimit
integer
pageOffset
integer

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Initiatives

Description

Tool to list initiatives. Use when you need a paginated list of initiatives with optional filters.

Action Parameters

archived
string
owner.email
string
status.id
string
status.name
string

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Jira Integrations

Description

Tool to list Jira integrations. Use when you need to retrieve Productboard's connected Jira integrations with optional pagination.

Action Parameters

pageUrl
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Key Results

Description

Tool to list key results. Use when you need a paginated list of key results.

Action Parameters

archived
boolean
owner.email
string
parent.id
string
status.id
string
status.name
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Notes

Description

Tool to list notes in Productboard. Use when you need to retrieve notes with optional filters and pagination. Follow links.next for additional pages.

Action Parameters

allTags
string
anyTag
string
companyId
string
createdFrom
string
createdTo
string
dateFrom
string
dateTo
string
featureId
string
last
string
ownerEmail
string
pageCursor
string
pageLimit
integer
source
string
term
string
updatedFrom
string
updatedTo
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Objectives

Description

Tool to list objectives from Productboard. Use when you need a paginated list of objectives with optional filters; follow 'links.next' to retrieve additional pages.

Action Parameters

archived
boolean
owner.email
string
parent.id
string
status.id
string
status.name
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Plugin Integrations

Description

Tool to list plugin integrations. Use when you need a paginated list of plugin integrations.

Action Parameters

pageUrl
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: List Products

Description

Tool to list all products in a workspace. Use when you need to retrieve paginated product details.

Action Parameters

pageLimit
integer
pageOffset
integer

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Release Groups

Description

Tool to list release groups. Use when you need a paginated list of release groups. Returns first page of results and link to next page.

Action Parameters

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Releases

Description

Tool to list all releases in Productboard. Use when you need a paginated list of releases; follow links.next for more pages.

Action Parameters

releaseGroup.id
string

Action Response

data
arrayRequired
error
string
links
objectRequired
successful
booleanRequired

Tool Name: List Users

Description

Tool to list users. Use when you need a paginated list of all users in Productboard.

Action Parameters

next
string

Action Response

data
arrayRequired
error
string
links
object
successful
booleanRequired

Tool Name: Remove Note Follower

Description

Tool to remove a follower from a Productboard note. Use after confirming the note ID and follower email are correct.

Action Parameters

email
stringRequired
noteId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Company

Description

Tool to retrieve details of a specific company. Use when you have the company ID to fetch its full details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Company Field

Description

Tool to retrieve details of a specific company custom field. Use when you have the custom field ID and need its metadata.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Company Field Value

Description

Tool to retrieve a specific company custom field value. Use when you need the current value of a custom field for a given company by its IDs.

Action Parameters

companyCustomFieldId
stringRequired
companyId
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Feature

Description

Tool to retrieve details of a specific feature. Use when you need complete info on one feature.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Note

Description

Tool to retrieve details of a specific note. Use when you have the note ID to fetch its full details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve Product

Description

Tool to retrieve details of a specific product. Use when you have the product ID to fetch its full details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Retrieve User

Description

Tool to retrieve details of a specific user. Use when you have the user ID to fetch its full details.

Action Parameters

id
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List SCIM Users

Description

Tool to list users via SCIM. Use when checking for existing users before creation.

Action Parameters

count
integer
filter
string
sortBy
string
sortOrder
string
startIndex
integer

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Company Field Value

Description

Tool to set or replace a specific company custom field's value. Use when you need to update a company's custom field after confirming the field ID and ensuring the new value matches the field type.

Action Parameters

companyCustomFieldId
stringRequired
companyId
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Set Custom Field Value

Description

Tool to set a custom field value on a hierarchy entity. Use when you need to update a product, component, or feature field with a specific value after confirming the field and entity IDs.

Action Parameters

customField.id
stringRequired
hierarchyEntity.id
stringRequired
value
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired