Overview - Corsair

Use Canny through Corsair: one client, typed API calls, local DB sync, and incoming webhooks. What you get:

13 typed API operations
4 synced entities (boards, comments, posts, votes) for fast .search() / .list()
4 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/canny

yarn add corsair @corsair-dev/canny

pnpm install corsair @corsair-dev/canny

bun add corsair @corsair-dev/canny

Add the plugin

corsair.ts

import Database from 'better-sqlite3';
import { createCorsair } from 'corsair';
import { canny } from '@corsair-dev/canny';

export const corsair = createCorsair({
	plugins: [
		canny(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	multiTenancy: true,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

With multiTenancy: true, scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

API Key (Recommended)

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

canny()

More: API Key

Connect a tenant

Mint a connect link and send the tenant to it. Hub hosts the page and delivers the result to your app — see Connect / OAuth.

const { connectUrl } = await corsair.manage.connect.createLink({
	plugin: 'canny',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List boards

const tenant = corsair.withTenant('acme');
await tenant.canny.api.boards.list({});

Create a post

const tenant = corsair.withTenant('acme');
await tenant.canny.api.posts.create({
	authorID: '5f1a2b3c4d5e6f7a8b9c0d1e',
	boardID: '5f1a2b3c4d5e6f7a8b9c0d1f',
	title: 'Add dark mode',
	details: 'It would be easier on the eyes at night.',
});

See the full list on the API page.

Query synced data

Search synced boards without hitting Canny.

const tenant = corsair.withTenant('acme');
const rows = await tenant.canny.db.boards.search({
	data: {},
	limit: 50,
});

Synced entities: boards, comments, posts, votes. See Database for filters and operators.

Webhooks

Fires when someone creates a post on a board.

canny({
    webhookHooks: {
        posts: {
            created: {
                after: async (ctx, result) => {
                    console.log('Canny post created:', result.data);
                }
            },
        },
    },
})

Mount your framework handler once (see Frameworks), then point the provider at that URL. Full event list: Webhooks. Concepts: Webhooks, Hooks.

What’s next

API reference

Every canny.api.* operation with input and output types.

Database

Synced entities, search filters, and operators.

Webhooks

Event paths, payloads, and webhookHooks examples.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​Webhooks

​What’s next

API reference

Database

Webhooks

Connect / OAuth

Use with agents

Setup

Example API calls

Query synced data

Webhooks

What’s next