WhatsApp plugin

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

11 typed API operations
4 synced entities (businessProfiles, contacts, messages, phoneNumbers) for fast .search() / .list()
2 incoming webhook event types

Setup

Install

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

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

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

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

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		whatsapp(),
	],
	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 WhatsApp API key before the first call: pnpm corsair setup --plugin=whatsapp --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.

whatsapp()

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

Example API calls

businessProfiles.get

const tenant = corsair.withTenant('acme');
await tenant.whatsapp.api.businessProfiles.get({});

media.upload

const tenant = corsair.withTenant('acme');
await tenant.whatsapp.api.media.upload({});

See the full list on the API page.

Query synced data

Synced entities support tenant.whatsapp.db.<entity>.search() and .list(): businessProfiles, contacts, messages, phoneNumbers. See Database for filters and operators.

Webhooks

This plugin registers 2 webhook event types. Configure the provider to POST to your Corsair HTTP handler, then use webhookHooks on the plugin factory. See Webhooks for every event path and payload shape, and Webhooks concept for routing.

What’s next

API reference

Every whatsapp.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.

Overview

Plugins

WhatsApp plugin

Setup

Example API calls

Query synced data

Webhooks

What’s next

API reference

Database

Webhooks

Connect / OAuth

Use with agents