Skip to main content

Canny Component

Interact with the Canny API to manage feedback boards, posts, votes, comments, and users.

Component key: canny · Changelog ↓

Description​

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​

key: cannyApiKey

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
InputNotesExample
API Key

The Canny API key. Generate one at Settings > API in the Canny admin panel.

Triggers​

Webhook​

Receives webhook events from Canny when configured events occur. | key: webhook

InputNotesExample
Connection

The Canny connection to use.

A Canny webhook sends notifications to the integration whenever events occur in Canny. All event types are sent automatically — there is no option to filter by event type.

How It Works​

When a webhook event is received, the trigger validates the request using HMAC-SHA256 signature verification with the API key from the connection. If the signature is invalid, the request is rejected.

Configuration​

Configure a webhook in the Canny admin panel:

  1. Navigate to Settings > API in Canny
  2. Under Webhooks, click Add Webhook
  3. Enter the flow's webhook URL as the Webhook URL
  4. Save the webhook configuration

Event Types​

All event types are sent to the webhook. Use a branch or filter step in the flow to handle specific events.

Available Events (14)
EventDescription
post.createdOccurs when a new post is created
post.editedOccurs when a post is edited
post.deletedOccurs when a post is deleted
post.jira_issue_linkedOccurs when a Jira issue is linked to a post
post.jira_issue_unlinkedOccurs when a Jira issue is unlinked from a post
post.tag_addedOccurs when a post is tagged
post.tag_removedOccurs when a post's tag is removed
post.status_changedOccurs when a post's status is changed
comment.createdOccurs when a new comment is created
comment.editedOccurs when a comment is edited
comment.deletedOccurs when a comment is deleted
vote.createdOccurs when a user votes on a post
vote.deletedOccurs when a user unvotes on a post

Refer to the Canny webhook documentation for the complete and up-to-date list.

Returned Data​

Example Payload (post.deleted)
{
  "created": "2026-04-16T20:12:49.566Z",
  "object": {
    "author": {
      "adminRole": "Owner",
      "avatarURL": null,
      "created": "2025-10-08T17:30:30.782Z",
      "email": "admin@example.com",
      "id": "553c3ef8b8cdcd1501ba9999",
      "isAdmin": true,
      "name": "Jane Smith",
      "url": "https://yourcompany.canny.io/admin/users/jane-smith",
      "userID": null
    },
    "board": {
      "created": "2026-04-16T00:10:27.227Z",
      "id": "553c3ef8b8cdcd1501ba5678",
      "name": "Feature Requests",
      "postCount": 4,
      "url": "https://yourcompany.canny.io/admin/board/feature-requests"
    },
    "by": null,
    "category": null,
    "commentCount": 0,
    "clickup": {
      "linkedTasks": []
    },
    "created": "2026-04-16T20:12:48.417Z",
    "customFields": [],
    "details": "It would be great to have a dark mode option for the dashboard.",
    "eta": "June 2026",
    "id": "553c3ef8b8cdcd1501ba1234",
    "imageURLs": [],
    "idea": null,
    "jira": {
      "linkedIssues": [],
      "linkedIssueIDs": []
    },
    "linear": {
      "linkedIssueIDs": []
    },
    "mergeHistory": [],
    "owner": null,
    "roadmaps": [],
    "score": 1,
    "status": "open",
    "statusChangedAt": "2026-04-16T20:12:48.417Z",
    "tags": [],
    "title": "Add dark mode support",
    "totalMRR": 0,
    "url": "https://yourcompany.canny.io/admin/board/feature-requests/p/add-dark-mode-support"
  },
  "objectType": "post",
  "type": "post.deleted"
}

Data Sources​

Select Board​

Selects a board from the Canny account. | key: selectBoard | type: picklist

InputNotesExample
Connection

The Canny connection to use.

Example Payload for Select Board⤓
Loading…

Select Category​

Selects a category from the Canny account. | key: selectCategory | type: picklist

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Example Payload for Select Category⤓
Loading…

Select Company​

Selects a company from the Canny account. | key: selectCompany | type: picklist

InputNotesExample
Connection

The Canny connection to use.

Example Payload for Select Company⤓
Loading…

Select Post​

Selects a post from the Canny account. | key: selectPost | type: picklist

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Example Payload for Select Post⤓
Loading…

Select Tag​

Selects a tag from the Canny account. | key: selectTag | type: picklist

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Example Payload for Select Tag⤓
Loading…

Select User​

Selects a user from the Canny account. | key: selectUser | type: picklist

InputNotesExample
Connection

The Canny connection to use.

Example Payload for Select User⤓
Loading…

Actions​

Change Post Status​

Changes the status of a post. | key: changePostStatus

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Changer ID

The admin performing the status change.

553c3ef8b8cdcd1501ba9999
Connection

The Canny connection to use.

Comment

Optional comment to attach to the status change.

We've moved this to our roadmap.
Post ID

The unique identifier of the post.

553c3ef8b8cdcd1501ba5678
Notify Voters

When true, notifies voters of the status change.

false
Status

The new status value (e.g., open, under review, planned, in progress, complete, closed).

planned
Example Payload for Change Post Status⤓
Loading…

Create Category​

Creates a new category in a board. | key: createCategory

InputNotesExample
Board ID

The unique identifier of the board.

553c3ef8b8cdcd1501ba1234
Name

The name of the category.

UI Improvements
Connection

The Canny connection to use.

Parent Category ID

Parent category ID for subcategories.

553c3ef8b8cdcd1501baabcd
Subscribe Admins

When true, subscribes admins to the category.

false
Example Payload for Create Category⤓
Loading…

Create Changelog Entry​

Creates a new changelog entry. | key: createEntry

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Connection

The Canny connection to use.

Details

The entry content (markdown supported).

We've added several new features to the dashboard...
Title

The changelog entry title.

New Dashboard Features
Type

Entry type: new, improved, or fixed.

new
Notify

When true, sends an email notification for the changelog entry.

false
Published

When true, publishes the changelog entry immediately.

false
Example Payload for Create Changelog Entry⤓
Loading…

Create Comment​

Creates a new comment on a post. | key: createComment

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Author ID

The unique identifier of the comment author.

553c3ef8b8cdcd1501ba9999
Comment Text

The text content of the comment.

Great idea! We should prioritize this.
Connection

The Canny connection to use.

Image URLs

JSON array of image URLs to attach.

[
  "https://example.com/image.png"
]
Internal

When true, the comment is internal-only and not visible to end users.

false
Parent Comment ID

Parent comment ID for threaded replies.

553c3ef8b8cdcd1501ba2222
Post ID

The unique identifier of the post.

553c3ef8b8cdcd1501ba5678
Example Payload for Create Comment⤓
Loading…

Create or Update User​

Creates a new user or updates an existing one by email. | key: createOrUpdateUser

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Companies

JSON array of company objects to associate with the user.

[
  {
    "created": "2026-04-15T22:51:00.528Z",
    "customFields": {
      "field1": "value1",
      "field2": "value2"
    },
    "id": "company123",
    "monthlySpend": 500,
    "name": "company name"
  }
]
Connection

The Canny connection to use.

Custom Fields

Custom field key-value pairs as JSON.

{
  "key": "value"
}
Email

The user's email address.

jane@example.com
User ID

The unique identifier of the user.

553c3ef8b8cdcd1501ba9999
Name

The user's display name.

Jane Smith
Example Payload for Create or Update User⤓
Loading…

Create Post​

Creates a new feedback post. | key: createPost

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Author ID

The unique identifier of the post author.

553c3ef8b8cdcd1501ba9999
Board ID

The unique identifier of the board.

553c3ef8b8cdcd1501ba1234
Category ID

Category to assign to the post.

553c3ef8b8cdcd1501baabcd
Connection

The Canny connection to use.

Custom Fields

Custom field key-value pairs as JSON.

{
  "key": "value"
}
Details

The content or description of the post.

It would be great to have a dark mode option for the dashboard.
ETA

Estimated delivery date in MM/YYYY format.

06/2025
ETA Public

When true, the ETA is visible to all users.

false
Image URLs

JSON array of image URLs to attach.

[
  "https://example.com/image.png"
]
Title

The title of the post.

Add dark mode support
Example Payload for Create Post⤓
Loading…

Create Tag​

Creates a new tag in a board. | key: createTag

InputNotesExample
Board ID

The unique identifier of the board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Name

The name of the tag.

bug
Example Payload for Create Tag⤓
Loading…

Create Vote​

Creates a vote on a post. | key: createVote

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Connection

The Canny connection to use.

Post ID

The unique identifier of the post.

553c3ef8b8cdcd1501ba5678
Voter ID

The unique identifier of the user casting the vote.

553c3ef8b8cdcd1501ba9999
Example Payload for Create Vote⤓
Loading…

Delete Category​

Deletes a category. | key: deleteCategory

InputNotesExample
Category ID

The unique identifier of the category.

553c3ef8b8cdcd1501baabcd
Connection

The Canny connection to use.

Example Payload for Delete Category⤓
Loading…

Delete Comment​

Deletes a comment. | key: deleteComment

InputNotesExample
Comment ID

The unique identifier of the comment.

553c3ef8b8cdcd1501ba2222
Connection

The Canny connection to use.

Example Payload for Delete Comment⤓
Loading…

Delete Company​

Deletes a company. | key: deleteCompany

InputNotesExample
Company ID

The unique identifier of the company.

553c3ef8b8cdcd1501ba1111
Connection

The Canny connection to use.

Example Payload for Delete Company⤓
Loading…

Delete Post​

Deletes a post. | key: deletePost

InputNotesExample
Connection

The Canny connection to use.

Post ID

The unique identifier of the post.

553c3ef8b8cdcd1501ba5678
Example Payload for Delete Post⤓
Loading…

Delete User​

Deletes a user. | key: deleteUser

InputNotesExample
Connection

The Canny connection to use.

User ID

The unique identifier of the user.

553c3ef8b8cdcd1501ba9999
Example Payload for Delete User⤓
Loading…

Delete Vote​

Deletes a vote. | key: deleteVote

InputNotesExample
Connection

The Canny connection to use.

Vote ID

The unique identifier of the vote.

553c3ef8b8cdcd1501ba3333
Example Payload for Delete Vote⤓
Loading…

List Boards​

Lists all boards. | key: listBoards

InputNotesExample
Connection

The Canny connection to use.

Example Payload for List Boards⤓
Loading…

List Categories​

Lists categories with optional board filter and pagination. | key: listCategories

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Skip

The number of results to skip before returning data (0-based).

0
Example Payload for List Categories⤓
Loading…

List Changelog Entries​

Lists changelog entries with optional filtering. | key: listEntries

InputNotesExample
Connection

The Canny connection to use.

Sort

Sort order for changelog entries.

nonPublishedFirst
Type

Entry type: new, improved, or fixed.

new
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Skip

The number of results to skip before returning data (0-based).

0
Example Payload for List Changelog Entries⤓
Loading…

List Comments​

Lists comments with optional filtering and cursor-based pagination. | key: listComments

InputNotesExample
Author ID

Filter by or specify the post author.

553c3ef8b8cdcd1501ba9999
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Company ID

Filter results by company.

553c3ef8b8cdcd1501ba1111
Connection

The Canny connection to use.

Cursor

Pagination cursor from a previous response.

next_abc123def456
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Post ID

Filter results by post.

553c3ef8b8cdcd1501ba5678
Example Payload for List Comments⤓
Loading…

List Companies​

Lists companies with cursor-based pagination. | key: listCompanies

InputNotesExample
Search

Search term to filter companies.

Acme
Connection

The Canny connection to use.

Cursor

Pagination cursor from a previous response.

next_abc123def456
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Segment

Filter by segment.

enterprise
Example Payload for List Companies⤓
Loading…

List Posts​

Lists posts with optional filtering and pagination. | key: listPosts

InputNotesExample
Author ID

Filter by or specify the post author.

553c3ef8b8cdcd1501ba9999
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Company ID

Filter results by company.

553c3ef8b8cdcd1501ba1111
Connection

The Canny connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Search

Search term to filter posts.

dark mode
Skip

The number of results to skip before returning data (0-based).

0
Sort

Sort order for post results.

newest
Status

Comma-separated list of statuses to filter by.

open,planned
Tag IDs

JSON array of tag IDs to filter by.

[
  "553c3ef8b8cdcd1501ba4444"
]
Example Payload for List Posts⤓
Loading…

List Status Changes​

Lists post status changes with optional filtering and cursor-based pagination. | key: listStatusChanges

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Cursor

Pagination cursor from a previous response.

next_abc123def456
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Example Payload for List Status Changes⤓
Loading…

List Tags​

Lists tags with optional board filter and pagination. | key: listTags

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Connection

The Canny connection to use.

Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Skip

The number of results to skip before returning data (0-based).

0
Example Payload for List Tags⤓
Loading…

List Users​

Lists users with cursor-based pagination. | key: listUsers

InputNotesExample
Connection

The Canny connection to use.

Cursor

Pagination cursor from a previous response.

next_abc123def456
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Example Payload for List Users⤓
Loading…

List Votes​

Lists votes with optional filtering and cursor-based pagination (v2). | key: listVotes

InputNotesExample
Board ID

Filter results by board.

553c3ef8b8cdcd1501ba1234
Company ID

Filter results by company.

553c3ef8b8cdcd1501ba1111
Connection

The Canny connection to use.

Cursor

Pagination cursor from a previous response.

next_abc123def456
Fetch All

When true, automatically fetches all pages of results using pagination.

false
Limit

Number of results to return per page.

10
Post ID

Filter results by post.

553c3ef8b8cdcd1501ba5678
User ID

Filter results by user.

553c3ef8b8cdcd1501ba9999
Example Payload for List Votes⤓
Loading…

Raw Request​

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

InputNotesExample
Connection

The Canny connection to use.

Data

The HTTP body payload to send to the URL.

{"exampleKey": "Example Data"}
File Data

File Data to be sent as a multipart form upload.

[{key: "example.txt", value: "My File Contents"}]
File Data File Names

File names to apply to the file data inputs. Keys must match the file data keys above.

Form Data

The Form Data to be sent as a multipart form upload.

[{"key": "Example Key", "value": new Buffer("Hello World")}]
Header

A list of headers to send with the request.

User-Agent: curl/7.64.1
Max Retry Count

The maximum number of retries to attempt. Specify 0 for no retries.

0
Method

The HTTP method to use.

Query Parameter

A 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.

Response Type

The type of data you expect in the response. You can request json, text, or binary data.

json
Retry On All Errors

If 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
Retry Delay (ms)

The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled.

0
Timeout

The maximum time that a client will await a response to its request

2000
URL

Input 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.

/v1/posts/list
Use Exponential Backoff

Specifies 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. | key: retrieveBoard

InputNotesExample
Connection

The Canny connection to use.

Board ID

The unique identifier of the board.

553c3ef8b8cdcd1501ba1234
Example Payload for Retrieve Board⤓
Loading…

Retrieve Category​

Retrieves a single category by ID. | key: retrieveCategory

InputNotesExample
Category ID

The unique identifier of the category.

553c3ef8b8cdcd1501baabcd
Connection

The Canny connection to use.

Example Payload for Retrieve Category⤓
Loading…

Retrieve Comment​

Retrieves a single comment by ID. | key: retrieveComment

InputNotesExample
Comment ID

The unique identifier of the comment.

553c3ef8b8cdcd1501ba2222
Connection

The Canny connection to use.

Example Payload for Retrieve Comment⤓
Loading…

Retrieve Post​

Retrieves a single post by ID. | key: retrievePost

InputNotesExample
Connection

The Canny connection to use.

Post ID

The unique identifier of the post.

553c3ef8b8cdcd1501ba5678
Example Payload for Retrieve Post⤓
Loading…

Retrieve Tag​

Retrieves a single tag by ID. | key: retrieveTag

InputNotesExample
Connection

The Canny connection to use.

Tag ID

The unique identifier of the tag.

553c3ef8b8cdcd1501ba4444
Example Payload for Retrieve Tag⤓
Loading…

Retrieve User​

Retrieves a single user by ID. | key: retrieveUser

InputNotesExample
Connection

The Canny connection to use.

User ID

The unique identifier of the user.

553c3ef8b8cdcd1501ba9999
Example Payload for Retrieve User⤓
Loading…

Retrieve Vote​

Retrieves a single vote by ID. | key: retrieveVote

InputNotesExample
Connection

The Canny connection to use.

Vote ID

The unique identifier of the vote.

553c3ef8b8cdcd1501ba3333
Example Payload for Retrieve Vote⤓
Loading…

Update Company​

Updates an existing company. | key: updateCompany

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Company ID

The unique identifier of the company.

553c3ef8b8cdcd1501ba1111
Name

The company name (0-100 characters).

Acme Corp
Connection

The Canny connection to use.

Custom Fields

Custom field key-value pairs as JSON.

{
  "key": "value"
}
Monthly Spend

Monthly recurring revenue in dollars.

5000
Example Payload for Update Company⤓
Loading…

Update Post​

Updates an existing post. | key: updatePost

InputNotesExample
Additional Fields

Additional fields that might not be covered by the standard inputs.

{
  "email": "sally@netflix.com"
}
Connection

The Canny connection to use.

Custom Fields

Custom field key-value pairs as JSON.

{
  "key": "value"
}
Details

Updated post content.

Updated description for the feature request.
ETA

Estimated delivery date in MM/YYYY format.

06/2025
Image URLs

JSON array of image URLs to attach.

[
  "https://example.com/image.png"
]
Post ID

The unique identifier of the post.

553c3ef8b8cdcd1501ba5678
Title

Updated post title.

Add dark mode support
Example Payload for Update Post⤓
Loading…

Changelog​

2026-04-21​

Initial release of the Canny component with support for boards, posts, comments, votes, categories, tags, users, companies, changelog entries, and status changes.