Overview - Corsair

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

31 typed API operations
10 synced entities (activityCall, activityEmail, activityNote, activitySms, contact, customField, and 4 more) for fast .search() / .list()
6 incoming webhook event types

Setup

Install

npm install corsair @corsair-dev/close

yarn add corsair @corsair-dev/close

pnpm install corsair @corsair-dev/close

bun add corsair @corsair-dev/close

Add the plugin

corsair.ts

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

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

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

close()

More: API Key

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

close({
	authType: 'oauth_2',
})

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

Example API calls

List leads

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

Create a lead

const tenant = corsair.withTenant('acme');
await tenant.close.api.leads.create({ name: 'Acme Inc.' });

See the full list on the API page.

Query synced data

This table exists, but Close calls don’t fill it yet. This returns only rows you have written yourself.

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

Synced entities: activityCall, activityEmail, activityNote, activitySms, contact, customField, lead, opportunity, task, user. See Database for filters and operators.

Webhooks

Fires when a lead is created.

close({
    webhookHooks: {
        lead: {
            created: {
                after: async (ctx, result) => {
                    console.log('Close lead 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 close.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