> ## 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.

# Postalytics plugin

> Manage direct mail campaigns, contacts, flows, templates, suppression lists, and outbound webhook configurations with the Postalytics API.

Use **Postalytics** through Corsair: one client, typed API calls.

Postalytics authenticates with an API key as the HTTP Basic username and an empty password. Set sandbox to true in plugin options to use the development host. Outbound webhook configuration is supported; inbound webhook verification is not implemented.

**What you get:**

* 44 typed API operations

## Setup

**1. Install**

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

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

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

```bash bun theme={null}
bun add corsair @corsair-dev/postalytics 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 { postalytics } from '@corsair-dev/postalytics';

export const corsair = createCorsair({
	plugins: [
		postalytics(),
	],
	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 Postalytics API key before the first call: `pnpm corsair setup --plugin=postalytics --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}
> postalytics()
> ```
>
> More: [API Key](https://docs.corsair.dev/concepts/api-key)

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

## Example API calls

**`account.getMyAccount`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.postalytics.api.account.getMyAccount({});
```

**`account.createNewAccount`**

```ts theme={null}
const tenant = corsair.withTenant('acme');
await tenant.postalytics.api.account.createNewAccount({
	body: {
		first_name: 'Thomas',
		last_name: 'Anderson',
		password: 'test-password',
		username: 'choi',
	},
});
```

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

## What's next

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

> [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.