Skip to main content
Canny logo
  • Category: product management
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 25
  • Triggers: 0
  • Slug: CANNY
  • Version: 20261101_00

Tools

Slug: CANNY_ADD_POST_TAGTool to add a tag to a specific post. Use when you need to categorize or group content by applying an existing tag.

Input Parameters

string
required
Unique identifier of the tag to add to the post.
string
required
Unique identifier of the post to which the tag will be added.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CHANGE_POST_STATUSTool to change a post’s status. Use when you need to update a post’s workflow stage and optionally notify voters.

Input Parameters

string
required
The unique identifier (MongoDB ObjectID) of the post whose status will be changed.
string
required
New status for the post. Common values include ‘open’, ‘under review’, ‘planned’, ‘in progress’, ‘complete’, ‘closed’, or any custom status configured in Canny.
string
required
The unique identifier (MongoDB ObjectID) of the admin user who is making the status change. Must be an admin user in Canny.
string
Optional comment to accompany the status change. This will be shown in the post’s activity feed. Supports newlines with ‘\n’.
array
Optional list of image URLs to attach to the status change comment. Must be valid, publicly accessible URLs.
boolean
Whether non-admin voters should be notified of the status change. Defaults to False to avoid unexpected notifications in automated workflows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CREATE_CHANGELOG_ENTRYTool to create and optionally publish a new changelog entry. Use when you need to add a product update record, control publish timing, and notify users. Example: “Create changelog entry titled ‘Version 1.2’ with details ’…’ and publish immediately.”.

Input Parameters

string ("fixed" | "new" | "improved")
Optional type of your changelog entry: ‘fixed’, ‘new’, or ‘improved’.
string
required
The title of your changelog entry.
boolean
If publishing immediately, whether to notify users by email. Defaults to false.
string
required
The Markdown-formatted details of your changelog entry.
array
List of post IDs to link to this changelog entry.
array
List of label IDs to assign to this changelog entry.
boolean
Whether to publish the entry immediately. Defaults to false.
string
If ‘published’ is true, override the publish date (ISO 8601 format, must not be in the future).
string
Schedule a future publish date (ISO 8601 format, must be in the future).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CREATE_COMMENTTool to create a new comment on a post. Use when you have the authorID and postID and want to submit feedback or replies.

Input Parameters

string
Text content of the comment, up to 2500 characters. Required if no images.
string
required
Unique identifier of the post to which the comment is added (Canny post ID). Use the ‘List Posts’ action to get valid post IDs.
string
required
Unique identifier of the comment’s author (Canny user ID). Use the ‘Create or Update User’ action to get a valid user ID.
boolean
Flag for internal-use-only comments. Can only be true if the author is a company member.
string
If this comment is a reply, the unique identifier of the parent comment (Canny comment ID).
string
Original creation timestamp in ISO 8601 format (useful for migrating comments)
array
List of image URLs to attach to the comment.
boolean
Whether to send email notifications to voters of the post.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CREATE_OR_UPDATE_USERCreates or updates a Canny user using an identifier and name, with optional profile fields and company associations. Admin users’ email, name, and avatar cannot be modified through the API.

Input Parameters

string
Canny’s unique identifier for the user. Use this to update an existing Canny user. At least one of ‘email’, ‘userID’, or ‘id’ must be provided.
string
required
The user’s name (1-50 characters).
string
Optional alias for the user.
string
The user’s email address. At least one of ‘email’, ‘userID’, or ‘id’ must be provided to identify the user.
string
Your application’s unique identifier for the user. Recommended for syncing users between your app and Canny. At least one of ‘email’, ‘userID’, or ‘id’ must be provided.
string
Date the user was created in your system (ISO 8601 format).
string
URL to the user’s avatar image.
array
List of companies associated with the user.
object
Custom fields for the user (keys 0-30 chars; string values <200 chars).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CREATE_POSTTool to create a new post (feature request or feedback) on a Canny board. Use this action when you need to submit new feedback or feature requests to a board. Requires a valid boardID (from list_boards) and authorID (from create_or_update_user or list_users).

Input Parameters

string
The estimated completion date for this post in MM/YYYY format.
string
The unique identifier of the admin who is creating the post on behalf of the author. Used when an admin submits feedback for a user.
string
required
The title of the post. Should be concise and descriptive.
string
required
The unique identifier of the board where the post will be created. Get this from list_boards action.
string
required
The detailed description or body of the post. This is the longer text field explaining the feature request or feedback.
string
The unique identifier of the user responsible for completing the work on this post.
string
required
The unique identifier of the user who is the author of the post. Get this from create_or_update_user or list_users action.
string
The original creation date of the post in ISO 8601 format. Useful for migrating posts from another system.
boolean
Whether the ETA should be visible to all users. Defaults to false.
array
List of URLs pointing to images to attach to the post.
string
The unique identifier of the category or subcategory to assign to this post.
object
Custom fields associated with the post. Keys must be 0-30 characters; string values under 200 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CREATE_TAGTool to create a new tag. Use when you have the boardID and tag name and need to categorize posts.

Input Parameters

string
required
Name of the tag, between 1 and 30 characters.
string
required
ID of the board where the tag should be created.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_CREATE_VOTETool to create a vote for a post. Use when you need to record or migrate a user’s vote on a post, optionally setting priority or original creation time. Example: Create a vote for postID abc123 with voterID user_456.

Input Parameters

string
The unique identifier of the user casting the vote on behalf of the voter. Must be a Canny administrator.
string
required
The unique identifier of the post to vote on.
string
required
The unique identifier of the user casting the vote.
string
If migrating votes, the original creation timestamp in ISO 8601 format.
integer ("0" | "10" | "20")
Priority of the vote: 0 (Nice to have), 10 (Important), or 20 (Must have).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_DELETE_COMMENTTool to delete a comment. Use when moderation is required to remove a specific comment by its id. Example: “Delete the comment with ID 553c3ef8b8cdcd1501ba1238.”

Input Parameters

string
required
The unique identifier of the comment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_DELETE_POSTTool to delete a post. Use when you need to permanently remove a post by its id. Example: “Delete the post with ID 553c3ef8b8cdcd1501ba1238.”

Input Parameters

string
required
The unique identifier of the post to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_DELETE_USERDeletes a user and their comments and votes. Posts with other comments or votes remain without the user as author; posts without other comments or votes are removed.

Input Parameters

string
required
The unique identifier of the user to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_DELETE_VOTETool to delete a vote. Use when you need to remove a user’s vote from a specific post by its id. Example: “Delete the vote from postID abc123 for voterID user_456.”

Input Parameters

string
required
The unique identifier of the post from which the vote will be removed.
string
required
The unique identifier of the user whose vote is being removed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_BOARDSTool to list all boards. Use when you need to retrieve every board for your company after authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_CATEGORIESTool to list categories. Use when fetching categories for a specific board by its ID.

Input Parameters

integer
Number of categories to skip. Defaults to 0 if not specified.
integer
Number of categories to return. Defaults to 10 if not specified.
string
Filter categories by this board’s ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_COMMENTSRetrieves a paginated list of comments from Canny. Comments can be filtered by board, post, author, or company. Use this action to: - Get all comments across your Canny instance - Find comments on a specific post (using postID) - List comments from a specific board (using boardID) - See comments by a specific user (using authorID) - Track feedback from a company’s users (using companyID) Returns comments ordered by creation date (newest first). Use ‘limit’ and ‘skip’ for pagination.

Input Parameters

integer
Number of comments to skip before returning results. Use with ‘limit’ for pagination (e.g., skip=10, limit=10 returns comments 11-20).
integer
Maximum number of comments to return per request. Use with ‘skip’ for pagination.
string
The unique identifier of a Canny post. When provided, only comments on this specific post are returned. Obtain this ID from List Posts or Create Post actions.
string
The unique identifier of a Canny board. When provided, only comments on posts belonging to this board are returned. Obtain this ID from List Boards or Retrieve Board actions.
string
The unique identifier of a Canny user. When provided, only comments created by this author are returned. Obtain this ID from List Users or Retrieve User actions.
string
The unique identifier of a company. When provided, only comments on posts created by users linked to this company are returned. Obtain this ID from List Companies action.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_COMPANIESTool to list companies associated with your Canny account. Use after authentication to retrieve companies with pagination support.

Input Parameters

integer
Maximum number of companies to return per page (1-100). Defaults to 10.
string
Pagination cursor from a previous response to fetch the next page of companies.
A string to search by company name. When used, pagination (cursor) is disabled.
string
The URL name of the segment to filter companies by.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_OPPORTUNITIESTool to list opportunities linked to posts. Use when you need to fetch customer opportunities synced from CRM.

Input Parameters

integer
Number of opportunities to skip before returning. Defaults to 0.
integer
Maximum number of opportunities to return. Defaults to 10 if unspecified.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_POSTSTool to list posts with various filters. Use after selecting a board or to search/filter posts.

Input Parameters

integer
Number of posts to skip before fetching; defaults to 0.
string ("newest" | "oldest" | "relevance" | "score" | "statusChanged" | "trending")
Order in which to fetch posts. ‘relevance’ requires a search value.
integer
Number of posts to fetch; defaults to 10.
string
Search query to filter posts by title or details.
string
Comma-separated list of statuses to filter by (e.g. ‘planned,complete’).
array
Only fetch posts tagged with at least one of these tag IDs.
string
ID of the board to fetch posts for.
string
Only fetch posts by this author ID.
string
Only fetch posts created by users linked to this company identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_TAGSTool to list tags. Use when fetching tags optionally filtered by board ID and handling pagination.

Input Parameters

integer
Number of tags to skip before returning results. Defaults to 0.
integer
Maximum number of tags to return. Defaults to 10.
string
Filter tags by this board’s ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_USERSList end-users in a Canny workspace using cursor-based pagination. Choose a page size from 1 to 100 (default 10) and use the returned cursor to request subsequent pages.

Input Parameters

integer
Number of users to fetch per page (1-100). Defaults to 10.
string
Pagination cursor from a previous response. Use this to fetch the next page of results.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_LIST_VOTESRetrieve votes from Canny with optional filtering by board, post, or voter. Use this action to: - Get all votes on a specific post (filter by postID) - Get all votes by a specific user (filter by voterID) - Get all votes on posts in a board (filter by boardID) - List all votes across the account (no filters) Results are paginated - use ‘limit’ and ‘skip’ parameters to navigate through pages. Check ‘hasMore’ in the response to determine if more results are available.

Input Parameters

integer
Number of votes to skip for pagination. Use with limit to paginate through results.
integer
Maximum number of votes to return (1-10000). Default: 10.
string
Filter votes by post ID. Get post IDs from CANNY_LIST_POSTS.
string
Filter votes by board ID. Get board IDs from CANNY_LIST_BOARDS.
string
Filter votes by voter (user) ID. Get user IDs from CANNY_LIST_USERS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_RETRIEVE_BOARDTool to retrieve details of a board by its ID. Use when you need metadata for a specific board.

Input Parameters

string
required
Unique identifier of the board (24-character hex string). Use CANNY_LIST_BOARDS to get available board IDs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_RETRIEVE_TAGTool to retrieve details of a tag by its ID. Use after obtaining a valid tag ID.

Input Parameters

string
required
Unique identifier of the tag to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_RETRIEVE_USERTool to retrieve user details by Canny user ID, app user ID, or email. Use when you have exactly one identifier and need full user information. Example: “Retrieve user with email user@example.com”

Input Parameters

string
Canny user ID (provide one of ‘id’, ‘userID’, or ‘email’).
string
User’s email address (provide one of ‘id’, ‘userID’, or ‘email’).
string
Your application user ID (provide one of ‘id’, ‘userID’, or ‘email’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CANNY_UPDATE_POSTTool to update post details. Use when you need to change a post’s title, details, ETA, images, or custom fields.

Input Parameters

string
Estimated completion date in MM/YYYY format, e.g., ‘06/2022’.
string
Short title of the post.
string
required
Unique identifier of the post to update.
string
Detailed text body of the post.
boolean
Whether the ETA should be visible to end-users.
array
List of image URLs to attach to the post.
object
Custom fields to set on the post. Keys must be 0-30 characters; values can be string, number, or boolean.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not