> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Close plugin

> Sales CRM. Manage leads, contacts, opportunities, tasks, and call, note, and SMS activities, and read email activities and custom fields.

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

**1. Install**

```bash npm theme={null}
npm install corsair @corsair-dev/close better-sqlite3
npm install --save-dev @types/better-sqlite3
```

```bash yarn theme={null}
yarn add corsair @corsair-dev/close better-sqlite3
yarn add --dev @types/better-sqlite3
```

```bash pnpm theme={null}
pnpm install corsair @corsair-dev/close better-sqlite3
pnpm install --save-dev @types/better-sqlite3
```

```bash bun theme={null}
bun add corsair @corsair-dev/close better-sqlite3
bun add --dev @types/better-sqlite3
```

**2. Add the plugin**

```ts corsair.ts theme={null}
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](https://docs.corsair.dev/quick-start.md) for KEK + Hub keys, and [Multi-tenancy](https://docs.corsair.dev/concepts/multi-tenancy.md) for account isolation.

**3. Choose authentication**

> [tab] API Key (Recommended)
>
> Store the Close API key before the first call: `pnpm corsair setup --plugin=close --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](https://docs.corsair.dev/concepts/api-key).
>
> ```ts theme={null}
> close()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

> [tab] OAuth 2.0
>
> Open [hub.corsair.dev](https://hub.corsair.dev/dashboard), navigate to your project, and enter the **client ID** and **client secret** from your Close OAuth app.
>
> ```ts theme={null}
> close({
> 	authType: 'oauth_2',
> })
> ```
>
> More: [OAuth 2.0](https://docs.corsair.dev/concepts/oauth)

**4. 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](https://docs.corsair.dev/management/connect).

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

## Example API calls

**List leads**

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

**Create a lead**

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

See the full list on the [API](https://docs.corsair.dev/plugins/close/api.md) page.

## Query synced data

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

```ts theme={null}
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](https://docs.corsair.dev/plugins/close/database.md) for filters and operators.

## Webhooks

Fires when a lead is created.

```ts theme={null}
close({
    webhookHooks: {
        lead: {
            created: {
                after: async (ctx, result) => {
                    console.log('Close lead created:', result.data);
                }
            },
        },
    },
})
```

Mount your framework handler once (see [Frameworks](https://docs.corsair.dev/frameworks/next.md)), then point the provider at that URL. Full event list: [Webhooks](https://docs.corsair.dev/plugins/close/webhooks.md). Concepts: [Webhooks](https://docs.corsair.dev/concepts/webhooks.md), [Hooks](https://docs.corsair.dev/concepts/hooks.md).

## What's next

> [card] [API reference](https://docs.corsair.dev/plugins/close/api.md)
>
> Every `close.api.*` operation with input and output types.

> [card] [Database](https://docs.corsair.dev/plugins/close/database.md)
>
> Synced entities, search filters, and operators.

> [card] [Webhooks](https://docs.corsair.dev/plugins/close/webhooks.md)
>
> Event paths, payloads, and `webhookHooks` examples.

> [card] [Connect / OAuth](https://docs.corsair.dev/management/connect)
>
> createLink, Hub delivery, and tenant connect flows.

> [card] [Use with agents](https://docs.corsair.dev/mcp-adapters/mcp-adapters)
>
> Expose this plugin's operations as MCP tools.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.