Skip to content
Scalekit Docs
Talk to an Engineer Dashboard

Connect AI agents to Canny

Scalekit connector
Open markdown

The Canny connector lets your AI agent act in each user's Canny account. Each user connects their own Canny API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 30 tools.

Tools
30
What they doRead · write · destructive
14 · 13 · 314 read13 write3 destructive
Users sign in with

Setup

  1. Install the SDK

    Terminal window
    npm install @scalekit-sdk/node dotenv
  2. Set your credentials

    Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

    .env
    SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
    SCALEKIT_CLIENT_ID=<your-client-id>
    SCALEKIT_CLIENT_SECRET=<your-client-secret>
  3. Create the Canny connection

    In AgentKit > Connections, create a Canny connection. The name you give it is the connection_name your code passes. See Configure connections.

  4. Authorize a user and make your first call

    quickstart.mts
    import { ScalekitClient } from '@scalekit-sdk/node'
    import 'dotenv/config'
    import { createInterface } from 'node:readline/promises'
    const scalekit = new ScalekitClient(
    process.env.SCALEKIT_ENVIRONMENT_URL,
    process.env.SCALEKIT_CLIENT_ID,
    process.env.SCALEKIT_CLIENT_SECRET,
    )
    const actions = scalekit.actions
    const connector = 'canny'
    const identifier = 'user_123'
    // Generate an authorization link for the user
    const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })
    console.log('Authorize Canny:', link)
    const rl = createInterface({ input: process.stdin, output: process.stdout })
    await rl.question('Press Enter after authorizing...')
    rl.close()
    // Make your first call
    const result = await actions.executeTool({
    connector,
    identifier,
    toolName: 'canny_boards_list',
    toolInput: {},
    })
    console.log(result)
    Terminal window
    npx tsx quickstart.mts

    Each user opens the link once and enters their Canny credentials there. See Authorize a user for the full flow and statuses.

Tools

Pass the exact name to execute_tool
Try in PlaygroundRequest a tool
  • canny_board_getGet one Canny board by ID.Read-only

    Get Board

    Get one Canny board by ID. Returns the board's id, name, postCount, isPrivate, privateComments, url and created time. Use List Boards to find board IDs.

    Inputs

    board_idstringrequired
    Canny ID of the board. Get it from List Boards. Example: 5f3a1b2c4d5e6f7890123456.
  • canny_boards_listList every feedback board in the Canny workspace.Read-only

    List Boards

    List every feedback board in the Canny workspace. Returns boards with id, name, postCount, isPrivate, privateComments, url and created time. Use this to get a board_id for the post, category and tag tools.

    Inputs

    This tool takes no inputs.

  • canny_categories_listList post categories in Canny, optionally for one board.Read-only

    List Categories

    List post categories in Canny, optionally for one board. Returns categories with id, name, board, parentID, postCount and url. Use this to get a category_id for Create Post or Change Post Category.

    Inputs

    board_idstring
    Only return results from this board. Get board IDs from List Boards. Example: 5f3a1b2c4d5e6f7890123456.
    limitinteger
    Number of results to return, 1 to 10000. Canny defaults to 10. Example: 25.
    skipinteger
    Number of results to skip before returning, for paging. Canny defaults to 0. Example: 25.
  • canny_changelog_entries_listList changelog entries in Canny, filtered by label, type or status.Read-only

    List Changelog Entries

    List changelog entries in Canny, filtered by label, type or status. Returns hasMore and entries with id, title, markdownDetails, plaintextDetails, status, types, labels, linked posts, publishedAt, scheduledFor and url. Use Create Changelog Entry to add one.

    Inputs

    label_idsarray
    Only entries with at least one of these labels. Example: ["5f3a1b2c4d5e6f7890123456"].
    limitinteger
    Number of results to return, 1 to 10000. Canny defaults to 10. Example: 25.
    skipinteger
    Entries to skip, up to 1,000. Canny defaults to 0. Example: 10.
    sortstring
    Sort order: created, lastSaved, publishedAt or nonPublishedFirst. Example: publishedAt.one of createdlastSavedpublishedAtnonPublishedFirst
    statusstring
    Comma-separated statuses: draft, scheduled, published. All if omitted. Example: published.
    typestring
    Entry type: new, improved or fixed. Example: new.one of newimprovedfixed
  • canny_comment_getGet one Canny comment by ID.Read-only

    Get Comment

    Get one Canny comment by ID. Returns the comment's id, value, author, board, post, parentID, internal flag, imageURLs, likeCount and created time. Use List Comments to find comment IDs.

    Inputs

    comment_idstringrequired
    Canny ID of the comment. Get it from List Comments. Example: 5f3a1b2c4d5e6f7890123456.
  • canny_comments_listList comments in Canny, filtered by post, board, author or company, with cursor paging.Read-only

    List Comments

    List comments in Canny, filtered by post, board, author or company, with cursor paging. Returns hasNextPage, cursor and items, each a comment with id, value, author, board, post, parentID, internal flag, imageURLs, likeCount and created time. Use Get Comment for one comment.

    Inputs

    author_idstring
    Canny ID of the comment author. Get it from List Users. Example: 5f3a1b2c4d5e6f7890123456.
    board_idstring
    Only return results from this board. Get board IDs from List Boards. Example: 5f3a1b2c4d5e6f7890123456.
    company_idstring
    Only return results from users linked to the company with this custom identifier (the ID from your own system). Example: acme-inc.
    cursorstring
    Pagination cursor from the previous response, to fetch the next page. Example: 6a2889c586d7b8843bf4cf10.
    limitinteger
    Number of results to return, 1 to 100. Canny defaults to 10. Example: 25.
    post_idstring
    Canny ID of the post. Get it from List Posts. Example: 5f3a1b2c4d5e6f7890123456.
  • canny_companies_listList companies in Canny, optionally searched by name or filtered by segment, with cursor paging.Read-only

    List Companies

    List companies in Canny, optionally searched by name or filtered by segment, with cursor paging. Returns hasNextPage, cursor and companies with id, name, domain, memberCount, monthlySpend, customFields and created time. Use the company id as company_id in the list tools.

    Inputs

    cursorstring
    Pagination cursor from the previous response, to fetch the next page. Example: 6a2889c586d7b8843bf4cf10.
    limitinteger
    Number of results to return, 1 to 100. Canny defaults to 10. Example: 25.
    searchstring
    Search by company name. Example: Acme.
    segmentstring
    URL name of a segment to filter by. Example: enterprise.
  • canny_post_getGet one Canny post by its ID, or by its urlName and board.Read-only

    Get Post

    Get one Canny post by its ID, or by its urlName and board. Returns the post's id, title, details, status, score, commentCount, board, category, tags, author, owner, eta, custom fields and url. Pass post_id, or url_name with board_id.

    Inputs

    board_idstring
    Board of the post. Only needed with url_name. Example: 5f3a1b2c4d5e6f7890123456.
    post_idstring
    Canny ID of the post. Get it from List Posts. Example: 5f3a1b2c4d5e6f7890123456.
    url_namestring
    The post's urlName (the slug in its URL). Requires board_id. Example: dark-mode.