Skip to main content

Canny Connector

Canny Canny is a customer feedback management platform that helps teams collect, organize, and prioritize product feedback. This component allows you to manage feedback boards, posts, votes, comments, categories, tags, users, and companies.

API Documentation

This component was built using the Canny API Reference.

Connections

API Key

Authenticate using a Canny API key.

To authenticate with Canny, an API key is required.

Prerequisites

  • A Canny account with admin access

Setup Steps

  1. Log in to the Canny admin panel
  2. Navigate to Settings > API
  3. Copy the API Key displayed on the page

Configure the Connection

  • Enter the API Key into the connection configuration
InputCommentsDefault
API KeyThe Canny API key. Generate one at Settings > API in the Canny admin panel.

Triggers

Webhook

Receives webhook events from Canny when configured events occur.

InputCommentsDefault
ConnectionThe Canny connection to use.

Actions

Change Post Status

Changes the status of a post.

InputCommentsDefault
ConnectionThe Canny connection to use.
Post IDThe unique identifier of the post.
StatusThe new status value (e.g., open, under review, planned, in progress, complete, closed).
Changer IDThe admin performing the status change.
Notify VotersWhen true, notifies voters of the status change.false
CommentOptional comment to attach to the status change.
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Create Category

Creates a new category in a board.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDThe unique identifier of the board.
NameThe name of the category.
Subscribe AdminsWhen true, subscribes admins to the category.false
Parent Category IDParent category ID for subcategories.

Create Changelog Entry

Creates a new changelog entry.

InputCommentsDefault
ConnectionThe Canny connection to use.
TitleThe changelog entry title.
DetailsThe entry content (markdown supported).
TypeEntry type: new, improved, or fixed.
NotifyWhen true, sends an email notification for the changelog entry.false
PublishedWhen true, publishes the changelog entry immediately.false
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Create Comment

Creates a new comment on a post.

InputCommentsDefault
ConnectionThe Canny connection to use.
Post IDThe unique identifier of the post.
Author IDThe unique identifier of the comment author.
Comment TextThe text content of the comment.
InternalWhen true, the comment is internal-only and not visible to end users.false
Parent Comment IDParent comment ID for threaded replies.
Image URLsJSON array of image URLs to attach.
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Create or Update User

Creates a new user or updates an existing one by email.

InputCommentsDefault
ConnectionThe Canny connection to use.
EmailThe user's email address.
NameThe user's display name.
User IDThe unique identifier of the user.
CompaniesJSON array of company objects to associate with the user.
Custom FieldsCustom field key-value pairs as JSON.
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Create Post

Creates a new feedback post.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDThe unique identifier of the board.
Author IDThe unique identifier of the post author.
TitleThe title of the post.
DetailsThe content or description of the post.
Category IDCategory to assign to the post.
Custom FieldsCustom field key-value pairs as JSON.
ETAEstimated delivery date in MM/YYYY format.
ETA PublicWhen true, the ETA is visible to all users.false
Image URLsJSON array of image URLs to attach.
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Create Tag

Creates a new tag in a board.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDThe unique identifier of the board.
NameThe name of the tag.

Create Vote

Creates a vote on a post.

InputCommentsDefault
ConnectionThe Canny connection to use.
Post IDThe unique identifier of the post.
Voter IDThe unique identifier of the user casting the vote.
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Delete Category

Deletes a category.

InputCommentsDefault
ConnectionThe Canny connection to use.
Category IDThe unique identifier of the category.

Delete Comment

Deletes a comment.

InputCommentsDefault
ConnectionThe Canny connection to use.
Comment IDThe unique identifier of the comment.

Delete Company

Deletes a company.

InputCommentsDefault
ConnectionThe Canny connection to use.
Company IDThe unique identifier of the company.

Delete Post

Deletes a post.

InputCommentsDefault
ConnectionThe Canny connection to use.
Post IDThe unique identifier of the post.

Delete User

Deletes a user.

InputCommentsDefault
ConnectionThe Canny connection to use.
User IDThe unique identifier of the user.

Delete Vote

Deletes a vote.

InputCommentsDefault
ConnectionThe Canny connection to use.
Vote IDThe unique identifier of the vote.

List Boards

Lists all boards.

InputCommentsDefault
ConnectionThe Canny connection to use.

List Categories

Lists categories with optional board filter and pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDFilter results by board.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
LimitNumber of results to return per page.
SkipThe number of results to skip before returning data (0-based).

List Changelog Entries

Lists changelog entries with optional filtering.

InputCommentsDefault
ConnectionThe Canny connection to use.
TypeEntry type: new, improved, or fixed.
SortSort order for changelog entries.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
LimitNumber of results to return per page.
SkipThe number of results to skip before returning data (0-based).

List Comments

Lists comments with optional filtering and cursor-based pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDFilter results by board.
Post IDFilter results by post.
Author IDFilter by or specify the post author.
Company IDFilter results by company.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
CursorPagination cursor from a previous response.
LimitNumber of results to return per page.

List Companies

Lists companies with cursor-based pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
SearchSearch term to filter companies.
SegmentFilter by segment.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
CursorPagination cursor from a previous response.
LimitNumber of results to return per page.

List Posts

Lists posts with optional filtering and pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDFilter results by board.
Author IDFilter by or specify the post author.
Company IDFilter results by company.
Tag IDsJSON array of tag IDs to filter by.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
LimitNumber of results to return per page.
SkipThe number of results to skip before returning data (0-based).
SearchSearch term to filter posts.
SortSort order for post results.
StatusComma-separated list of statuses to filter by.

List Status Changes

Lists post status changes with optional filtering and cursor-based pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDFilter results by board.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
CursorPagination cursor from a previous response.
LimitNumber of results to return per page.

List Tags

Lists tags with optional board filter and pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDFilter results by board.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
LimitNumber of results to return per page.
SkipThe number of results to skip before returning data (0-based).

List Users

Lists users with cursor-based pagination.

InputCommentsDefault
ConnectionThe Canny connection to use.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
CursorPagination cursor from a previous response.
LimitNumber of results to return per page.

List Votes

Lists votes with optional filtering and cursor-based pagination (v2).

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDFilter results by board.
Post IDFilter results by post.
Company IDFilter results by company.
User IDFilter results by user.
Fetch AllWhen true, automatically fetches all pages of results using pagination.false
CursorPagination cursor from a previous response.
LimitNumber of results to return per page.

Raw Request

Sends a raw HTTP request to the Canny API. The API key is injected automatically into the request body.

InputCommentsDefault
ConnectionThe Canny connection to use.
URLInput the path only (e.g., /v1/posts/list). The base URL is already included (https://canny.io/api). For example, to connect to https://canny.io/api/v1/posts/list, only /v1/posts/list is entered in this field.
MethodThe HTTP method to use.
DataThe HTTP body payload to send to the URL.
Form DataThe Form Data to be sent as a multipart form upload.
File DataFile Data to be sent as a multipart form upload.
File Data File NamesFile names to apply to the file data inputs. Keys must match the file data keys above.
Query ParameterA list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2.
HeaderA list of headers to send with the request.
Response TypeThe type of data you expect in the response. You can request json, text, or binary data.json
TimeoutThe maximum time that a client will await a response to its request
Retry Delay (ms)The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.0
Retry On All ErrorsIf true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors.false
Max Retry CountThe maximum number of retries to attempt. Specify 0 for no retries.0
Use Exponential BackoffSpecifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored.false

Retrieve Board

Retrieves a single board by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
Board IDThe unique identifier of the board.

Retrieve Category

Retrieves a single category by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
Category IDThe unique identifier of the category.

Retrieve Comment

Retrieves a single comment by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
Comment IDThe unique identifier of the comment.

Retrieve Post

Retrieves a single post by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
Post IDThe unique identifier of the post.

Retrieve Tag

Retrieves a single tag by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
Tag IDThe unique identifier of the tag.

Retrieve User

Retrieves a single user by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
User IDThe unique identifier of the user.

Retrieve Vote

Retrieves a single vote by ID.

InputCommentsDefault
ConnectionThe Canny connection to use.
Vote IDThe unique identifier of the vote.

Update Company

Updates an existing company.

InputCommentsDefault
ConnectionThe Canny connection to use.
Company IDThe unique identifier of the company.
NameThe company name (0-100 characters).
Monthly SpendMonthly recurring revenue in dollars.
Custom FieldsCustom field key-value pairs as JSON.
Additional FieldsAdditional fields that might not be covered by the standard inputs.

Update Post

Updates an existing post.

InputCommentsDefault
ConnectionThe Canny connection to use.
Post IDThe unique identifier of the post.
TitleUpdated post title.
DetailsUpdated post content.
Custom FieldsCustom field key-value pairs as JSON.
ETAEstimated delivery date in MM/YYYY format.
Image URLsJSON array of image URLs to attach.
Additional FieldsAdditional fields that might not be covered by the standard inputs.