Canny
cannyCanny is a customer feedback management platform that helps teams collect, analyze, and prioritize user feedback to build better products.
Acciones disponibles (25)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Add Post TagCANNY_ADD_POST_TAGAcciónTool to add a tag to a specific post. use when you need to categorize or group content by applying an existing tag.
CANNY_ADD_POST_TAGAcciónTool to add a tag to a specific post. use when you need to categorize or group content by applying an existing tag.
Parámetros de entrada
tagIDstringObligatorioUnique identifier of the tag to add to the post.
postIDstringObligatorioUnique identifier of the post to which the tag will be added.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete UserCANNY_CANNY_DELETE_USERAcciónTool to delete a user and their comments and votes. use when you need to fully remove a user's account and all associated data (e.g., gdpr compliance).
CANNY_CANNY_DELETE_USERAcciónTool to delete a user and their comments and votes. use when you need to fully remove a user's account and all associated data (e.g., gdpr compliance).
Parámetros de entrada
idstringObligatorioThe unique identifier of the user to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Change Post StatusCANNY_CHANGE_POST_STATUSAcciónTool to change a post's status. use when you need to update a post's workflow stage and optionally notify voters.
CANNY_CHANGE_POST_STATUSAcciónTool to change a post's status. use when you need to update a post's workflow stage and optionally notify voters.
Parámetros de entrada
postIDstringObligatorioUnique identifier of the post to update.
statusstringObligatorioNew status for the post. Common values include 'open', 'under review', 'planned', 'in progress', 'complete', 'closed', or any custom status configured in Canny.
changerIDstringObligatorioIdentifier of the admin making the status change.
commentValuestringOptional comment for the status change. Use ' ' for new lines.
commentImageURLsstring[]Optional list of image URLs to attach to the status change.
shouldNotifyVotersbooleanWhether non-admin voters should be notified of the status change.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create Changelog EntryCANNY_CREATE_CHANGELOG_ENTRYAcciónTool 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.".
CANNY_CREATE_CHANGELOG_ENTRYAcciónTool 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.".
Parámetros de entrada
typestringenumOptional type of your changelog entry: 'fixed', 'new', or 'improved'.
fixednewimprovedtitlestringObligatorioThe title of your changelog entry.
notifybooleanIf publishing immediately, whether to notify users by email. Defaults to false.
detailsstringObligatorioThe Markdown-formatted details of your changelog entry.
postIDsstring[]List of post IDs to link to this changelog entry.
labelIDsstring[]List of label IDs to assign to this changelog entry.
publishedbooleanWhether to publish the entry immediately. Defaults to false.
publishedOnstringIf 'published' is true, override the publish date (ISO 8601 format, must not be in the future).
scheduledForstringSchedule a future publish date (ISO 8601 format, must be in the future).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create CommentCANNY_CREATE_COMMENTAcciónTool to create a new comment on a post. use when you have the authorid and postid and want to submit feedback or replies.
CANNY_CREATE_COMMENTAcciónTool to create a new comment on a post. use when you have the authorid and postid and want to submit feedback or replies.
Parámetros de entrada
valuestringText content of the comment, up to 2500 characters. Required if no images.
postIDstringObligatorioUnique identifier of the post to which the comment is added.
authorIDstringObligatorioUnique identifier of the comment's author.
internalbooleanFlag for internal-use-only comments. Can only be true if the author is a company member.
parentIDstringIf this comment is a reply, the unique identifier of the parent comment.
createdAtstringOriginal creation timestamp in ISO 8601 format (useful for migrating comments)
imageURLsstring[]List of image URLs to attach to the comment.
shouldNotifyVotersbooleanWhether to send email notifications to voters of the post.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create or Update UserCANNY_CREATE_OR_UPDATE_USERAcciónTool to create or update a user in canny. use when you need to provision a new user or synchronize updates to an existing user profile. example: "create or update user with email user@example.com"
CANNY_CREATE_OR_UPDATE_USERAcciónTool to create or update a user in canny. use when you need to provision a new user or synchronize updates to an existing user profile. example: "create or update user with email user@example.com"
Parámetros de entrada
idstringCanny's unique identifier for the user.
namestringObligatorioThe user's name (1-50 characters).
aliasstringOptional alias for the user.
emailstringThe user's email address.
userIDstringYour application's unique identifier for the user.
createdstringDate the user was created in your system (ISO 8601 format).
avatarURLstringURL to the user's avatar image.
companiesobject[]List of companies associated with the user.
customFieldsobjectCustom fields for the user (keys 0-30 chars; string values <200 chars).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create PostCANNY_CREATE_POSTAcciónTool to create a new post on a board. use when you have the boardid and userid and need to submit new feedback.
CANNY_CREATE_POSTAcciónTool to create a new post on a board. use when you have the boardid and userid and need to submit new feedback.
Parámetros de entrada
tagsstring[]List of tags to associate with the post.
titlestringObligatorioTitle of the post.
userIDstringObligatorioID of the user creating the post.
boardIDstringObligatorioID of the board where the post will be created.
createdintegerUnix timestamp for when the post was created. Defaults to server time if not provided.
detailsstringDetailed description or body of the post.
isPrivatebooleanFlag indicating if the post should be private.
assigneeIDstringID of the team member assigned to the post.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create TagCANNY_CREATE_TAGAcciónTool to create a new tag. use when you have the boardid and tag name and need to categorize posts.
CANNY_CREATE_TAGAcciónTool to create a new tag. use when you have the boardid and tag name and need to categorize posts.
Parámetros de entrada
namestringObligatorioName of the tag, between 1 and 30 characters.
boardIDstringObligatorioID of the board where the tag should be created.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create VoteCANNY_CREATE_VOTEAcciónTool 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.
CANNY_CREATE_VOTEAcciónTool 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.
Parámetros de entrada
byIDstringThe unique identifier of the user casting the vote on behalf of the voter. Must be a Canny administrator.
postIDstringObligatorioThe unique identifier of the post to vote on.
voterIDstringObligatorioThe unique identifier of the user casting the vote.
createdAtstringIf migrating votes, the original creation timestamp in ISO 8601 format.
votePriorityintegerenumPriority of the vote: 0 (Nice to have), 10 (Important), or 20 (Must have).
01020
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete CommentCANNY_DELETE_COMMENTAcciónTool to delete a comment. use when moderation is required to remove a specific comment by its id. example: "delete the comment with id 553c3ef8b8cdcd1501ba1238."
CANNY_DELETE_COMMENTAcciónTool to delete a comment. use when moderation is required to remove a specific comment by its id. example: "delete the comment with id 553c3ef8b8cdcd1501ba1238."
Parámetros de entrada
commentIDstringObligatorioThe unique identifier of the comment to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete PostCANNY_DELETE_POSTAcciónTool to delete a post. use when you need to permanently remove a post by its id. example: "delete the post with id 553c3ef8b8cdcd1501ba1238."
CANNY_DELETE_POSTAcciónTool to delete a post. use when you need to permanently remove a post by its id. example: "delete the post with id 553c3ef8b8cdcd1501ba1238."
Parámetros de entrada
postIDstringObligatorioThe unique identifier of the post to delete.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete VoteCANNY_DELETE_VOTEAcciónTool 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."
CANNY_DELETE_VOTEAcciónTool 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."
Parámetros de entrada
postIDstringObligatorioThe unique identifier of the post from which the vote will be removed.
voterIDstringObligatorioThe unique identifier of the user whose vote is being removed.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List BoardsCANNY_LIST_BOARDSAcciónTool to list all boards. use when you need to retrieve every board for your company after authentication.
CANNY_LIST_BOARDSAcciónTool to list all boards. use when you need to retrieve every board for your company after authentication.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CategoriesCANNY_LIST_CATEGORIESAcciónTool to list categories. use when fetching categories for a specific board by its id.
CANNY_LIST_CATEGORIESAcciónTool to list categories. use when fetching categories for a specific board by its id.
Parámetros de entrada
skipintegerNumber of categories to skip. Defaults to 0 if not specified.
limitintegerNumber of categories to return. Defaults to 10 if not specified.
boardIDstringFilter categories by this board's ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CommentsCANNY_LIST_COMMENTSAcciónTool to list comments for posts, boards, or authors. use after authentication to fetch comments with optional filters.
CANNY_LIST_COMMENTSAcciónTool to list comments for posts, boards, or authors. use after authentication to fetch comments with optional filters.
Parámetros de entrada
skipintegerNumber of comments to skip before fetching (default: 0).
limitintegerNumber of comments to fetch (default: 10).
postIDstringFilter comments by this post ID.
boardIDstringFilter comments by this board ID.
authorIDstringFilter comments by this author ID.
companyIDstringFetch comments for posts created by users linked to this company ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List CompaniesCANNY_LIST_COMPANIESAcciónTool to list companies associated with your canny account. use after authentication to retrieve companies with pagination support.
CANNY_LIST_COMPANIESAcciónTool to list companies associated with your canny account. use after authentication to retrieve companies with pagination support.
Parámetros de entrada
limitintegerMaximum number of companies to return (1-100).
cursorstringPagination cursor from a previous listCompanies response.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List OpportunitiesCANNY_LIST_OPPORTUNITIESAcciónTool to list opportunities linked to posts. use when you need to fetch customer opportunities synced from crm.
CANNY_LIST_OPPORTUNITIESAcciónTool to list opportunities linked to posts. use when you need to fetch customer opportunities synced from crm.
Parámetros de entrada
skipintegerNumber of opportunities to skip before returning. Defaults to 0.
limitintegerMaximum number of opportunities to return. Defaults to 10 if unspecified.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List PostsCANNY_LIST_POSTSAcciónTool to list posts with various filters. use after selecting a board or to search/filter posts.
CANNY_LIST_POSTSAcciónTool to list posts with various filters. use after selecting a board or to search/filter posts.
Parámetros de entrada
skipintegerNumber of posts to skip before fetching; defaults to 0.
sortstringenumOrder in which to fetch posts. 'relevance' requires a search value.
newestoldestrelevancescorestatusChangedtrendinglimitintegerNumber of posts to fetch; defaults to 10.
searchstringSearch query to filter posts by title or details.
statusstringComma-separated list of statuses to filter by (e.g. 'planned,complete').
tagIDsstring[]Only fetch posts tagged with at least one of these tag IDs.
boardIDstringID of the board to fetch posts for.
authorIDstringOnly fetch posts by this author ID.
companyIDstringOnly fetch posts created by users linked to this company identifier.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List TagsCANNY_LIST_TAGSAcciónTool to list tags. use when fetching tags optionally filtered by board id and handling pagination.
CANNY_LIST_TAGSAcciónTool to list tags. use when fetching tags optionally filtered by board id and handling pagination.
Parámetros de entrada
skipintegerNumber of tags to skip before returning results. Defaults to 0.
limitintegerMaximum number of tags to return. Defaults to 10.
boardIDstringFilter tags by this board's ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List UsersCANNY_LIST_USERSAcciónTool to list end-users in your workspace. use when you need to fetch and paginate through your workspace's users.
CANNY_LIST_USERSAcciónTool to list end-users in your workspace. use when you need to fetch and paginate through your workspace's users.
Parámetros de entrada
limitintegerNumber of entries to fetch (1-100). Defaults to 10.
cursorstringCursor from a previous request to continue pagination.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List VotesCANNY_LIST_VOTESAcciónTool to list votes for a post. use after retrieving post details to view voters.
CANNY_LIST_VOTESAcciónTool to list votes for a post. use after retrieving post details to view voters.
Parámetros de entrada
skipintegerNumber of votes to skip before fetching (default: 0).
limitintegerNumber of votes to fetch (default: 10).
postIDstringFilter votes by this post ID.
boardIDstringFilter votes by this board ID.
voterIDstringFilter votes by this voter ID.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve BoardCANNY_RETRIEVE_BOARDAcciónTool to retrieve details of a board by its id. use when you need metadata for a specific board.
CANNY_RETRIEVE_BOARDAcciónTool to retrieve details of a board by its id. use when you need metadata for a specific board.
Parámetros de entrada
idstringObligatorioUnique identifier of the board.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve TagCANNY_RETRIEVE_TAGAcciónTool to retrieve details of a tag by its id. use after obtaining a valid tag id.
CANNY_RETRIEVE_TAGAcciónTool to retrieve details of a tag by its id. use after obtaining a valid tag id.
Parámetros de entrada
idstringObligatorioUnique identifier of the tag to retrieve.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve UserCANNY_RETRIEVE_USERAcciónTool 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"
CANNY_RETRIEVE_USERAcciónTool 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"
Parámetros de entrada
idstringCanny user ID (provide one of 'id', 'userID', or 'email').
emailstringUser's email address (provide one of 'id', 'userID', or 'email').
userIDstringYour application user ID (provide one of 'id', 'userID', or 'email').
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update PostCANNY_UPDATE_POSTAcciónTool to update post details. use when you need to change a post's title, details, eta, images, or custom fields.
CANNY_UPDATE_POSTAcciónTool to update post details. use when you need to change a post's title, details, eta, images, or custom fields.
Parámetros de entrada
etastringEstimated completion date in MM/YYYY format, e.g., '06/2022'.
titlestringShort title of the post.
postIDstringObligatorioUnique identifier of the post to update.
detailsstringDetailed text body of the post.
etaPublicbooleanWhether the ETA should be visible to end-users.
imageURLsstring[]List of image URLs to attach to the post.
customFieldsobjectCustom fields to set on the post. Keys must be 0-30 characters; values can be string, number, or boolean.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not