![canny icon](/docs/img/components/icons/60/Y2Fubnk=.png)

# Canny Connector

key: canny[Source](https://github.com/prismatic-io/components/tree/main/components/canny)[Connector Changelog](#changelog)

## Description[​](#description "Direct link to Description")

[Canny](https://canny.io/) 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[​](#api-documentation "Direct link to API Documentation")

This component was built using the [Canny API Reference](https://developers.canny.io/api-reference).

## Connections[​](#connections "Direct link to Connections")

### API Key[​](#cannyapikey "Direct link to API Key")

**key: cannyApiKey**

To authenticate with Canny, an API key is required.

#### Prerequisites[​](#prerequisites "Direct link to Prerequisites")

* A Canny account with admin access

#### Setup Steps[​](#setup-steps "Direct link to Setup Steps")

1. Log in to the [Canny admin panel](https://canny.io/)
2. Navigate to **Settings** > **API**
3. Copy the **API Key** displayed on the page

#### Configure the Connection[​](#configure-the-connection "Direct link to Configure the Connection")

* Enter the **API Key** into the connection configuration

| Input   | Notes                                                                       | Example |
| ------- | --------------------------------------------------------------------------- | ------- |
| API Key | The Canny API key. Generate one at Settings > API in the Canny admin panel. |         |

## Triggers[​](#triggers "Direct link to Triggers")

### New and Updated Posts[​](#pollchangestrigger "Direct link to New and Updated Posts")

Checks for new and updated Posts in Canny on a configured schedule. | **key: pollChangesTrigger**

| Input                | Notes                                                                                         | Example |
| -------------------- | --------------------------------------------------------------------------------------------- | ------- |
| Connection           | The Canny connection to use.                                                                  |         |
| Show New Records     | When true, posts created since the last poll are included in the trigger output.              | true    |
| Show Updated Records | When true, posts whose status changed since the last poll are included in the trigger output. | true    |

This trigger polls [Canny](https://canny.io/) on a configured schedule and emits posts that were created, or had a status change, since the previous run. It is a convenient alternative to webhooks when a scheduled pull is preferred over an event push.

#### How It Works[​](#how-it-works "Direct link to How It Works")

Canny's posts endpoint does not support filtering by date, so on each scheduled run the trigger fetches posts and classifies them against the previous poll time:

* **Created**: posts whose `created` timestamp is after the previous poll.
* **Updated**: posts whose `statusChangedAt` is after the previous poll (and that are not newly created).

The current run time is stored as the cursor for the next run.

* **First run**: the very first execution records the cursor and emits nothing, so an instance does not receive a backlog of historical posts on deploy.
* **Subsequent runs**: only posts created or status-changed since the last run are returned.

#### Returned Data[​](#returned-data "Direct link to Returned Data")

The trigger returns the matching posts grouped under `created` and `updated`. Fields shown are representative. The full response object includes additional properties.

Example Payload

```json
{
  "data": {
    "created": [
      {
        "id": "553c3ef8b8cdcd1501ba1238",
        "title": "An awesome feature request",
        "status": "in progress",
        "created": "2026-04-16T01:07:22.189Z",
        "statusChangedAt": "2026-04-16T01:07:22.189Z"
      }
    ],
    "updated": []
  }
}

```

#### Notes[​](#notes "Direct link to Notes")

* "Updated" detection is based on each post's `statusChangedAt`, which reflects status transitions. Other edits that do not change status are not detected.
* Because Canny has no server-side date filter, each run lists posts and filters them in memory; for very large boards consider scoping with the underlying list filters.

***

### Webhook[​](#webhook "Direct link to Webhook")

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

| Input      | Notes                        | Example |
| ---------- | ---------------------------- | ------- |
| Connection | The Canny connection to use. |         |

A Canny [webhook](https://developers.canny.io/api-reference#webhooks) 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[​](#how-it-works-1 "Direct link to 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[​](#configuration "Direct link to 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[​](#event-types "Direct link to 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)

| Event                      | Description                                      |
| -------------------------- | ------------------------------------------------ |
| `post.created`             | Occurs when a new post is created                |
| `post.edited`              | Occurs when a post is edited                     |
| `post.deleted`             | Occurs when a post is deleted                    |
| `post.jira_issue_linked`   | Occurs when a Jira issue is linked to a post     |
| `post.jira_issue_unlinked` | Occurs when a Jira issue is unlinked from a post |
| `post.tag_added`           | Occurs when a post is tagged                     |
| `post.tag_removed`         | Occurs when a post's tag is removed              |
| `post.status_changed`      | Occurs when a post's status is changed           |
| `comment.created`          | Occurs when a new comment is created             |
| `comment.edited`           | Occurs when a comment is edited                  |
| `comment.deleted`          | Occurs when a comment is deleted                 |
| `vote.created`             | Occurs when a user votes on a post               |
| `vote.deleted`             | Occurs when a user unvotes on a post             |

Refer to the [Canny webhook documentation](https://developers.canny.io/api-reference#webhooks) for the complete and up-to-date list.

#### Returned Data[​](#returned-data-1 "Direct link to Returned Data")

Example Payload (post.deleted)

```json
{
  "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[​](#data-sources "Direct link to Data Sources")

### Select Board[​](#selectboard "Direct link to Select Board")

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

| Input      | Notes                        | Example |
| ---------- | ---------------------------- | ------- |
| Connection | The Canny connection to use. |         |

Example Payload for <!-- -->Select Board[⤓](https://prismatic.io/docs/example-payloads/canny/data-sources/selectBoard.json "Download example payload")

Loading…

***

### Select Category[​](#selectcategory "Direct link to Select Category")

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

| Input      | Notes                        | Example                  |
| ---------- | ---------------------------- | ------------------------ |
| Board ID   | Filter results by board.     | 553c3ef8b8cdcd1501ba1234 |
| Connection | The Canny connection to use. |                          |

Example Payload for <!-- -->Select Category[⤓](https://prismatic.io/docs/example-payloads/canny/data-sources/selectCategory.json "Download example payload")

Loading…

***

### Select Company[​](#selectcompany "Direct link to Select Company")

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

| Input      | Notes                        | Example |
| ---------- | ---------------------------- | ------- |
| Connection | The Canny connection to use. |         |

Example Payload for <!-- -->Select Company[⤓](https://prismatic.io/docs/example-payloads/canny/data-sources/selectCompany.json "Download example payload")

Loading…

***

### Select Post[​](#selectpost "Direct link to Select Post")

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

| Input      | Notes                        | Example                  |
| ---------- | ---------------------------- | ------------------------ |
| Board ID   | Filter results by board.     | 553c3ef8b8cdcd1501ba1234 |
| Connection | The Canny connection to use. |                          |

Example Payload for <!-- -->Select Post[⤓](https://prismatic.io/docs/example-payloads/canny/data-sources/selectPost.json "Download example payload")

Loading…

***

### Select Tag[​](#selecttag "Direct link to Select Tag")

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

| Input      | Notes                        | Example                  |
| ---------- | ---------------------------- | ------------------------ |
| Board ID   | Filter results by board.     | 553c3ef8b8cdcd1501ba1234 |
| Connection | The Canny connection to use. |                          |

Example Payload for <!-- -->Select Tag[⤓](https://prismatic.io/docs/example-payloads/canny/data-sources/selectTag.json "Download example payload")

Loading…

***

### Select User[​](#selectuser "Direct link to Select User")

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

| Input      | Notes                        | Example |
| ---------- | ---------------------------- | ------- |
| Connection | The Canny connection to use. |         |

Example Payload for <!-- -->Select User[⤓](https://prismatic.io/docs/example-payloads/canny/data-sources/selectUser.json "Download example payload")

Loading…

***

## Actions[​](#actions "Direct link to Actions")

### Change Post Status[​](#changepoststatus "Direct link to Change Post Status")

Changes the status of a post. | **key: changePostStatus**

| Input             | Notes                                                                                    | Example                          |
| ----------------- | ---------------------------------------------------------------------------------------- | -------------------------------- |
| Additional Fields | Additional fields that might not be covered by the standard inputs.                      | See Example                      |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/changePostStatus.json "Download example payload")

Loading…

***

### Create Category[​](#createcategory "Direct link to Create Category")

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

| Input              | Notes                                         | Example                  |
| ------------------ | --------------------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createCategory.json "Download example payload")

Loading…

***

### Create Changelog Entry[​](#createentry "Direct link to Create Changelog Entry")

Creates a new changelog entry. | **key: createEntry**

| Input             | Notes                                                               | Example                                              |
| ----------------- | ------------------------------------------------------------------- | ---------------------------------------------------- |
| Additional Fields | Additional fields that might not be covered by the standard inputs. | See Example                                          |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createEntry.json "Download example payload")

Loading…

***

### Create Comment[​](#createcomment "Direct link to Create Comment")

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

| Input             | Notes                                                                 | Example                                |
| ----------------- | --------------------------------------------------------------------- | -------------------------------------- |
| Additional Fields | Additional fields that might not be covered by the standard inputs.   | See Example                            |
| 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.                                   | See Example                            |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createComment.json "Download example payload")

Loading…

***

### Create or Update User[​](#createorupdateuser "Direct link to Create or Update User")

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

| Input             | Notes                                                               | Example                  |
| ----------------- | ------------------------------------------------------------------- | ------------------------ |
| Additional Fields | Additional fields that might not be covered by the standard inputs. | See Example              |
| Companies         | JSON array of company objects to associate with the user.           | See Example              |
| Connection        | The Canny connection to use.                                        |                          |
| Custom Fields     | Custom field key-value pairs as JSON.                               | See Example              |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createOrUpdateUser.json "Download example payload")

Loading…

***

### Create Post[​](#createpost "Direct link to Create Post")

Creates a new feedback post. | **key: createPost**

| Input             | Notes                                                               | Example                                                         |
| ----------------- | ------------------------------------------------------------------- | --------------------------------------------------------------- |
| Additional Fields | Additional fields that might not be covered by the standard inputs. | See Example                                                     |
| 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.                               | See Example                                                     |
| 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.                                 | See Example                                                     |
| Title             | The title of the post.                                              | Add dark mode support                                           |

Example Payload for <!-- -->Create Post[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createPost.json "Download example payload")

Loading…

***

### Create Tag[​](#createtag "Direct link to Create Tag")

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

| Input      | Notes                               | Example                  |
| ---------- | ----------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createTag.json "Download example payload")

Loading…

***

### Create Vote[​](#createvote "Direct link to Create Vote")

Creates a vote on a post. | **key: createVote**

| Input             | Notes                                                               | Example                  |
| ----------------- | ------------------------------------------------------------------- | ------------------------ |
| Additional Fields | Additional fields that might not be covered by the standard inputs. | See Example              |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/createVote.json "Download example payload")

Loading…

***

### Delete Category[​](#deletecategory "Direct link to Delete Category")

Deletes a category. | **key: deleteCategory**

| Input       | Notes                                  | Example                  |
| ----------- | -------------------------------------- | ------------------------ |
| Category ID | The unique identifier of the category. | 553c3ef8b8cdcd1501baabcd |
| Connection  | The Canny connection to use.           |                          |

Example Payload for <!-- -->Delete Category[⤓](https://prismatic.io/docs/example-payloads/canny/actions/deleteCategory.json "Download example payload")

Loading…

***

### Delete Comment[​](#deletecomment "Direct link to Delete Comment")

Deletes a comment. | **key: deleteComment**

| Input      | Notes                                 | Example                  |
| ---------- | ------------------------------------- | ------------------------ |
| Comment ID | The unique identifier of the comment. | 553c3ef8b8cdcd1501ba2222 |
| Connection | The Canny connection to use.          |                          |

Example Payload for <!-- -->Delete Comment[⤓](https://prismatic.io/docs/example-payloads/canny/actions/deleteComment.json "Download example payload")

Loading…

***

### Delete Company[​](#deletecompany "Direct link to Delete Company")

Deletes a company. | **key: deleteCompany**

| Input      | Notes                                 | Example                  |
| ---------- | ------------------------------------- | ------------------------ |
| Company ID | The unique identifier of the company. | 553c3ef8b8cdcd1501ba1111 |
| Connection | The Canny connection to use.          |                          |

Example Payload for <!-- -->Delete Company[⤓](https://prismatic.io/docs/example-payloads/canny/actions/deleteCompany.json "Download example payload")

Loading…

***

### Delete Post[​](#deletepost "Direct link to Delete Post")

Deletes a post. | **key: deletePost**

| Input      | Notes                              | Example                  |
| ---------- | ---------------------------------- | ------------------------ |
| Connection | The Canny connection to use.       |                          |
| Post ID    | The unique identifier of the post. | 553c3ef8b8cdcd1501ba5678 |

Example Payload for <!-- -->Delete Post[⤓](https://prismatic.io/docs/example-payloads/canny/actions/deletePost.json "Download example payload")

Loading…

***

### Delete User[​](#deleteuser "Direct link to Delete User")

Deletes a user. | **key: deleteUser**

| Input      | Notes                              | Example                  |
| ---------- | ---------------------------------- | ------------------------ |
| Connection | The Canny connection to use.       |                          |
| User ID    | The unique identifier of the user. | 553c3ef8b8cdcd1501ba9999 |

Example Payload for <!-- -->Delete User[⤓](https://prismatic.io/docs/example-payloads/canny/actions/deleteUser.json "Download example payload")

Loading…

***

### Delete Vote[​](#deletevote "Direct link to Delete Vote")

Deletes a vote. | **key: deleteVote**

| Input      | Notes                              | Example                  |
| ---------- | ---------------------------------- | ------------------------ |
| Connection | The Canny connection to use.       |                          |
| Vote ID    | The unique identifier of the vote. | 553c3ef8b8cdcd1501ba3333 |

Example Payload for <!-- -->Delete Vote[⤓](https://prismatic.io/docs/example-payloads/canny/actions/deleteVote.json "Download example payload")

Loading…

***

### List Boards[​](#listboards "Direct link to List Boards")

Lists all boards. | **key: listBoards**

| Input      | Notes                        | Example |
| ---------- | ---------------------------- | ------- |
| Connection | The Canny connection to use. |         |

Example Payload for <!-- -->List Boards[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listBoards.json "Download example payload")

Loading…

***

### List Categories[​](#listcategories "Direct link to List Categories")

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

| Input      | Notes                                                                   | Example                  |
| ---------- | ----------------------------------------------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listCategories.json "Download example payload")

Loading…

***

### List Changelog Entries[​](#listentries "Direct link to List Changelog Entries")

Lists changelog entries with optional filtering. | **key: listEntries**

| Input      | Notes                                                                   | Example           |
| ---------- | ----------------------------------------------------------------------- | ----------------- |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listEntries.json "Download example payload")

Loading…

***

### List Comments[​](#listcomments "Direct link to List Comments")

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

| Input      | Notes                                                                   | Example                  |
| ---------- | ----------------------------------------------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listComments.json "Download example payload")

Loading…

***

### List Companies[​](#listcompanies "Direct link to List Companies")

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

| Input      | Notes                                                                   | Example            |
| ---------- | ----------------------------------------------------------------------- | ------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listCompanies.json "Download example payload")

Loading…

***

### List Posts[​](#listposts "Direct link to List Posts")

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

| Input      | Notes                                                                   | Example                  |
| ---------- | ----------------------------------------------------------------------- | ------------------------ |
| 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.                                     | See Example              |

Example Payload for <!-- -->List Posts[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listPosts.json "Download example payload")

Loading…

***

### List Status Changes[​](#liststatuschanges "Direct link to List Status Changes")

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

| Input      | Notes                                                                   | Example                  |
| ---------- | ----------------------------------------------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listStatusChanges.json "Download example payload")

Loading…

***

### List Tags[​](#listtags "Direct link to List Tags")

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

| Input      | Notes                                                                   | Example                  |
| ---------- | ----------------------------------------------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listTags.json "Download example payload")

Loading…

***

### List Users[​](#listusers "Direct link to List Users")

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

| Input      | Notes                                                                   | Example            |
| ---------- | ----------------------------------------------------------------------- | ------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listUsers.json "Download example payload")

Loading…

***

### List Votes[​](#listvotes "Direct link to List Votes")

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

| Input      | Notes                                                                   | Example                  |
| ---------- | ----------------------------------------------------------------------- | ------------------------ |
| 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[⤓](https://prismatic.io/docs/example-payloads/canny/actions/listVotes.json "Download example payload")

Loading…

***

### Raw Request[​](#rawrequest "Direct link to Raw Request")

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

| Input                   | Notes                                                                                                                                                                                                               | Example                                                       |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------- |
| 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[​](#retrieveboard "Direct link to Retrieve Board")

Retrieves a single board by ID. | **key: retrieveBoard**

| Input      | Notes                               | Example                  |
| ---------- | ----------------------------------- | ------------------------ |
| Connection | The Canny connection to use.        |                          |
| Board ID   | The unique identifier of the board. | 553c3ef8b8cdcd1501ba1234 |

Example Payload for <!-- -->Retrieve Board[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrieveBoard.json "Download example payload")

Loading…

***

### Retrieve Category[​](#retrievecategory "Direct link to Retrieve Category")

Retrieves a single category by ID. | **key: retrieveCategory**

| Input       | Notes                                  | Example                  |
| ----------- | -------------------------------------- | ------------------------ |
| Category ID | The unique identifier of the category. | 553c3ef8b8cdcd1501baabcd |
| Connection  | The Canny connection to use.           |                          |

Example Payload for <!-- -->Retrieve Category[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrieveCategory.json "Download example payload")

Loading…

***

### Retrieve Comment[​](#retrievecomment "Direct link to Retrieve Comment")

Retrieves a single comment by ID. | **key: retrieveComment**

| Input      | Notes                                 | Example                  |
| ---------- | ------------------------------------- | ------------------------ |
| Comment ID | The unique identifier of the comment. | 553c3ef8b8cdcd1501ba2222 |
| Connection | The Canny connection to use.          |                          |

Example Payload for <!-- -->Retrieve Comment[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrieveComment.json "Download example payload")

Loading…

***

### Retrieve Post[​](#retrievepost "Direct link to Retrieve Post")

Retrieves a single post by ID. | **key: retrievePost**

| Input      | Notes                              | Example                  |
| ---------- | ---------------------------------- | ------------------------ |
| Connection | The Canny connection to use.       |                          |
| Post ID    | The unique identifier of the post. | 553c3ef8b8cdcd1501ba5678 |

Example Payload for <!-- -->Retrieve Post[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrievePost.json "Download example payload")

Loading…

***

### Retrieve Tag[​](#retrievetag "Direct link to Retrieve Tag")

Retrieves a single tag by ID. | **key: retrieveTag**

| Input      | Notes                             | Example                  |
| ---------- | --------------------------------- | ------------------------ |
| Connection | The Canny connection to use.      |                          |
| Tag ID     | The unique identifier of the tag. | 553c3ef8b8cdcd1501ba4444 |

Example Payload for <!-- -->Retrieve Tag[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrieveTag.json "Download example payload")

Loading…

***

### Retrieve User[​](#retrieveuser "Direct link to Retrieve User")

Retrieves a single user by ID. | **key: retrieveUser**

| Input      | Notes                              | Example                  |
| ---------- | ---------------------------------- | ------------------------ |
| Connection | The Canny connection to use.       |                          |
| User ID    | The unique identifier of the user. | 553c3ef8b8cdcd1501ba9999 |

Example Payload for <!-- -->Retrieve User[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrieveUser.json "Download example payload")

Loading…

***

### Retrieve Vote[​](#retrievevote "Direct link to Retrieve Vote")

Retrieves a single vote by ID. | **key: retrieveVote**

| Input      | Notes                              | Example                  |
| ---------- | ---------------------------------- | ------------------------ |
| Connection | The Canny connection to use.       |                          |
| Vote ID    | The unique identifier of the vote. | 553c3ef8b8cdcd1501ba3333 |

Example Payload for <!-- -->Retrieve Vote[⤓](https://prismatic.io/docs/example-payloads/canny/actions/retrieveVote.json "Download example payload")

Loading…

***

### Update Company[​](#updatecompany "Direct link to Update Company")

Updates an existing company. | **key: updateCompany**

| Input             | Notes                                                               | Example                  |
| ----------------- | ------------------------------------------------------------------- | ------------------------ |
| Additional Fields | Additional fields that might not be covered by the standard inputs. | See Example              |
| 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.                               | See Example              |
| Monthly Spend     | Monthly recurring revenue in dollars.                               | 5000                     |

Example Payload for <!-- -->Update Company[⤓](https://prismatic.io/docs/example-payloads/canny/actions/updateCompany.json "Download example payload")

Loading…

***

### Update Post[​](#updatepost "Direct link to Update Post")

Updates an existing post. | **key: updatePost**

| Input             | Notes                                                               | Example                                      |
| ----------------- | ------------------------------------------------------------------- | -------------------------------------------- |
| Additional Fields | Additional fields that might not be covered by the standard inputs. | See Example                                  |
| Connection        | The Canny connection to use.                                        |                                              |
| Custom Fields     | Custom field key-value pairs as JSON.                               | See Example                                  |
| 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.                                 | See Example                                  |
| Post ID           | The unique identifier of the post.                                  | 553c3ef8b8cdcd1501ba5678                     |
| Title             | Updated post title.                                                 | Add dark mode support                        |

Example Payload for <!-- -->Update Post[⤓](https://prismatic.io/docs/example-payloads/canny/actions/updatePost.json "Download example payload")

Loading…

***

## Changelog[​](#changelog "Direct link to Changelog")

### 2026-06-02[​](#2026-06-02 "Direct link to 2026-06-02")

Added the **New and Updated Posts** polling trigger, which checks for posts created or with a status change since the last run

### 2026-04-21[​](#2026-04-21 "Direct link to 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.