Overview - Corsair

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

87 typed API operations
6 synced entities (channels, files, messages, reminders, scheduled_messages, users) for fast .search() / .list()
10 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/slackbot

yarn add corsair @corsair-dev/slackbot

pnpm install corsair @corsair-dev/slackbot

bun add corsair @corsair-dev/slackbot

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		slackbot(),
	],
	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

OAuth 2.0 (Recommended)

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Slack Bot OAuth app.

slackbot()

More: OAuth 2.0

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: 'slackbot',
	tenantId: 'acme',
});
// redirect the user's browser to connectUrl

Example API calls

List channels

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

Post a message

const tenant = corsair.withTenant('acme');
await tenant.slackbot.api.messages.post({ channel: 'C01234567', text: 'Hello from Corsair' });

See the full list on the API page.

Query synced data

Search synced channels without hitting Slack’s API.

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

Synced entities: channels, files, messages, reminders, scheduled_messages, users. See Database for filters and operators.

Webhooks

Fires when someone posts in a public channel the bot can see.

slackbot({
    webhookHooks: {
        messages: {
            message: {
                after: async (ctx, result) => {
                    console.log('Slack message:', 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 slackbot.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