The Canny API lets you communicate with Canny and build your own tools using Canny's data. You can read and write information to and from Canny using the API. Check out the docs below:

____

Things you can do with the API:

Boards:

  • Fetch a Board
  • List all Boards

Changelog:

  • Fetch Changelog entries and their corresponding details

Comments:

  • Fetch a specific comment, or a list of comments for a Post, Board, or Author
  • Retrieve comment details, including the comment body
  • Create a new comment
  • Delete an existing comment

Posts:

  • Fetch a specific post, or a list of posts for a Board or user
  • Return a list of posts. Include parameters to specify Board, user, query, pagination, filtering, and sorting
  • Retrieve the details of an existing post
  • Create a new Post
  • Add a Post status
  • Tag/Untag a Post
  • Fetch a list of status changes, sorted chronologically
  • Create, List, and Retrieve Tags

Users:

  • Find, create, and delete users
  • Vote on behalf of a user
  • Fetch a specific vote, or a list of votes associated with a Post, Board, or Author.
  • Delete votes

Webhooks

By setting up webhooks, your server will be notified of Canny events as they happen. For example, if a user creates a new post, we would send a request to your server to let you know.

You can set up webhooks for your account in the API & Webhooks settings page.

Events:

  • post.created — Occurs when a new post is created.
  • 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.status_changed — Occurs when a post's status is changed.
  • comment.created — Occurs when a new comment is created.
  • 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.

__

Related Articles:

Did this answer your question?