Postalytics plugin

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

Install

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

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

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

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

Add the plugin

corsair.ts

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 for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

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.

postalytics()

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

Example API calls

account.getMyAccount

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

account.createNewAccount

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

What’s next

API reference

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

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

Overview

Plugins