Canny

Add a bot to Canny using the official integration.

Open in Hubv0.2.0

The official Canny integration allows your bot to manage posts and comments in your Canny feature request boards.

Setup

You will need:

• A published bot
• A Canny account

1. Install the integration in Botpress

   First, install the integration to your bot:

   1. In Botpress Studio, select Explore Hub in the upper-right corner.
   2. Search for the Canny integration, then select Install Integration.

   In the Configuration menu, you should see one field: API key. Leave it empty for now—you’ll come back to it after getting your Canny API key.

2. Get your Canny API key

   Next, get your Canny API key:

   1. Log in to your Canny dashboard.
   2. In the top-right corner, select your profile icon and go to Settings.
   3. From the left sidebar, go to API.
   4. Copy your API key.
3. Configure the integration in Botpress

   Now, you can finish setting up the integration in Botpress:

   1. In the integration’s API Key field, paste your Canny API key.
   2. Select Save Configuration.

Your Canny integration is ready. You can use the integration’s Cards to interact with your Canny account.

Cards

Here’s a reference for all Cards available with the integration:

Create Comment

Input:

Output:

Create or Update User

Input:

Output:

Show output

user · object · required

Show child attributes

id · string · required

name · string · required

email · string · required

avatarURL · string

userId · string · required

isAdmin · boolean · required

created · string · required

Create Post

Input:

Output:

Delete Comment

Input:

Output:

This Card has no output.

Delete Post

Input:

Output:

This Card has no output.

Get Comment

Input:

Output:

Show output

comment · object · required

Show child attributes

id · string · required

value · string · required

authorName · string · required

authorEmail · string · required

postTitle · string · required

postId · string · required

created · string · required

internal · boolean · required

likeCount · number · required

Get Post

Input:

Output:

Show output

post · object · required

Show child attributes

id · string · required

title · string · required

details · string

authorName · string

authorEmail · string

boardName · string · required

status · string · required

score · number · required

commentCount · number · required

created · string · required

url · string · required

List Boards

Input:

Output:

Show output

boards · array · required

Show array item properties

id · string · required

name · string · required

postCount · number · required

url · string · required

created · string · required

List Comments

Input:

Output:

Show output

comments · array · required

Show array item properties

id · string · required

value · string · required

authorName · string · required

authorEmail · string · required

postTitle · string · required

postId · string · required

created · string · required

internal · boolean · required

likeCount · number · required

List Posts

Input:

Show input fields

sort · enum<string>

Available options: newest, oldest, relevance, score, statusChanged, trending

Output:

Show output

posts · array · required

Show array item properties

id · string · required

title · string · required

details · string

authorName · string

authorEmail · string

boardName · string · required

status · string · required

score · number · required

commentCount · number · required

created · string · required

url · string · required

List Users

Input:

Output:

Show output

users · array · required

Show array item properties

id · string · required

name · string · required

email · string · required

avatarURL · string

userId · string · required

isAdmin · boolean · required

created · string · required

Update Post

Input:

Output:

This Card has no output.