|
| 1 | +This integration provides comprehensive access to Canny's API for managing posts and comments in your feature request boards. |
| 2 | + |
| 3 | +# Features |
| 4 | + |
| 5 | +## Actions |
| 6 | + |
| 7 | +**Post Management:** |
| 8 | + |
| 9 | +- **Create Post**: Create new posts in your Canny boards |
| 10 | +- **Get Post**: Retrieve detailed information about a specific post |
| 11 | +- **List Posts**: List posts with filtering and pagination options |
| 12 | +- **Update Post**: Modify existing posts (title, details, ETA, etc.) |
| 13 | +- **Delete Post**: Remove posts from your boards |
| 14 | + |
| 15 | +**Comment Management:** |
| 16 | + |
| 17 | +- **Create Comment**: Add comments to posts |
| 18 | +- **Get Comment**: Retrieve comment details |
| 19 | +- **List Comments**: List comments with filtering options |
| 20 | +- **Delete Comment**: Remove comments |
| 21 | + |
| 22 | +## Channels |
| 23 | + |
| 24 | +**Posts Channel:** |
| 25 | + |
| 26 | +- Handles conversations where posts are the main topic and comments are replies |
| 27 | +- When users send messages in conversations, they're automatically created as comments on the associated post |
| 28 | + |
| 29 | +## Events |
| 30 | + |
| 31 | +**Webhook Support:** |
| 32 | + |
| 33 | +- Automatically creates conversations when new posts are created in Canny |
| 34 | +- Adds messages to conversations when new comments are posted |
| 35 | +- The first message in each conversation is the post content, and subsequent messages are comments |
| 36 | + |
| 37 | +# Configuration |
| 38 | + |
| 39 | +To use this integration, you'll need: |
| 40 | + |
| 41 | +1. **API Key**: Your Canny API key (get this from your Canny account settings) |
| 42 | + |
| 43 | +# Author ID |
| 44 | + |
| 45 | +Posts and comments will appear as "Botpress" unless you provide a specific `authorId`. |
| 46 | + |
| 47 | +To use a different author, provide an `authorId` of an existing user in your Canny workspace. You can find available user Ids using the "List Users" action. |
| 48 | + |
| 49 | +# Usage Examples |
| 50 | + |
| 51 | +## Setting up Webhooks |
| 52 | + |
| 53 | +Configure webhooks in your Canny account to point to your Botpress integration endpoint to automatically sync posts and comments as conversations. |
| 54 | + |
| 55 | +# Conversation Flow |
| 56 | + |
| 57 | +1. **Post Creation**: When a new post is created in Canny, a new conversation is started in Botpress |
| 58 | +2. **Comment Replies**: When users reply in the conversation, new comments are created on the original post |
| 59 | +3. **Thread Management**: Each post becomes a conversation thread with comments as messages |
0 commit comments