Canny

Getting Started with Canny

Prerequisites

  • A Canny account

In order to use Canny with Make, it is necessary to have a Canny account. If you do not have one, you can create a Canny account at canny.io/register.

Connecting Canny to Make

Instant triggers are connected via webhooks. Actions and Searches are connected using the API Key.

Connecting Instant Triggers via Webhooks

  1. Create a webhook using the Canny instant trigger module dialog. Select which events performed in Canny should trigger the module. Copy the webhook URL to your clipboard.

    61f268680b06d.gif
  2. Log in to the Canny user interface.

  3. Open the Settings > API & Webhooks.

  4. Add the created webhook into the Webhooks section.

    61f2686a6e0b1.gif
  5. The connection is created. When the specified Canny events happen, the instant trigger module will be triggered.

Connecting Actions and Searches Using the API Key.

  1. In Canny, go to the Settings > API & Webhooks.

  2. Copy the provided Secret API Key.

    61f2686cca9b4.png
  3. Paste the key into the API Key field in the Make Canny module and click on the Continue button.

    61f2686e1e8b9.png

The connection to the module is now established.

Triggers

Retrieves a post's details when triggered.

Webhook

Establish a connection to your Canny account.

Event types

Select the events that trigger this module.

Triggers when a post is upvoted or/and downvoted.

Webhook

Establish a connection to your Canny account.

Event types

Select whether you want this trigger to be triggered when a user votes on a post or when a user unvotes on a post.

Triggers when a post comment is created or/and deleted.

Webhook

Establish a connection to your Canny account.

Event types

Select whether you want this trigger to be triggered when a user adds a comment or/and when a user deletes a comment.

Actions

Changes the status of a selected post.

Connection

Establish a connection to your Canny account using the API Key.

Changer ID

Enter the ID of the user who has changed the status. The ID can be retrieved, for example, using the Watch Comments module.

Post ID

Enter the ID of the post whose status you want to change. The ID can be retrieved, for example, using the Watch Comments module.

Should notify voters

If this option is enabled, non-admin voters of the status change will be notified.

Status

Select the status you want to change the post to.

61f2686f289f8.png

Allows you to perform a custom API call.

Connection

Establish a connection to your Canny account using the API Key.

URL

Enter a path relative to https://canny.io/api. For example: /v1/votes/list/.

Note

For the list of available endpoints, refer to the Canny API Reference.

Method

Select the HTTP method you want to use:

Note

The method may differ depending on the 3rd party service. For example, some services use the POST method to retrieve a list of objects.

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query string

Enter the request query string.

Body

Enter the body content for your API call.

The following API call returns all votes in your Canny account:

URL:

/v1/votes/list/

Method:

POST

61f268704447d.png

The result can be found in the module's Output under Bundle > Body > votes.

In our example, 2 votes were returned:

61f2687186f67.png

Searches

Gets information about all boards in Canny.

Connection

Establish a connection to your Canny account using the API Key.

Board ID(optional)

Select or map the board you'd like to fetch posts for.

Author ID(optional)

If entered or mapped, the module will only fetch posts by the author with this ID.

Status (optional)

Select the status. If specified, only posts with these statuses will be retrieved.

Limit

Enter the number of posts Make will retrieve during one execution cycle.

Sort

Set retrieved posts sorting.