Sendbird plugin

Use Sendbird through Corsair: one client, typed API calls, local DB sync. API calls do not automatically sync entities to the local database. Configure a matching API token and application ID together; mismatched credentials may target the token’s application. What you get:

15 typed API operations
3 synced entities (channels, messages, users) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/sendbird better-sqlite3
npm install --save-dev @types/better-sqlite3

yarn add corsair @corsair-dev/sendbird better-sqlite3
yarn add --dev @types/better-sqlite3

pnpm install corsair @corsair-dev/sendbird better-sqlite3
pnpm install --save-dev @types/better-sqlite3

bun add corsair @corsair-dev/sendbird better-sqlite3
bun add --dev @types/better-sqlite3

Add the plugin

corsair.ts

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

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

Store the Sendbird API key before the first call: pnpm corsair setup --plugin=sendbird --tenant=acme api_key=<your-key> (leave out --tenant without multiTenancy), or pass it as key in the plugin options. With Hub, each tenant enters their own key on the connect page. See API key auth.Provide a matching API token and application ID, or store both on the same tenant using set_api_key and set_applicationId.

sendbird()

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

Example API calls

channels.get

const tenant = corsair.withTenant('acme');
await tenant.sendbird.api.channels.get({ channel_url: 'example-channel' });

channels.create

const tenant = corsair.withTenant('acme');
await tenant.sendbird.api.channels.create({
	user_ids: ['user-1'],
});

See the full list on the API page.

Query synced data

Synced entities support tenant.sendbird.db.<entity>.search() and .list(): channels, messages, users. See Database for filters and operators.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins