Fireberry plugin

Use Fireberry through Corsair: one client, typed API calls. Configure an API key in Corsair. Fireberry REST and Batch endpoints send it as the tokenid header; Metadata API calls follow the documented tokenid query parameter. API route inventory: 244 documented method/path operations across REST, Metadata, and Batch; 243 are dispatched by the generic typed Corsair operations. The Date & Time custom field update route is excluded because its published path and parameter contradict one another. No inbound webhook contract is published in the API index, so webhooks are not exposed. What you get:

24 typed API operations

Setup

Install

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

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

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

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

Add the plugin

corsair.ts

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

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

fireberry()

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

Example API calls

Inspect an account field

const tenant = corsair.withTenant('acme');
await tenant.fireberry.api.metadata.field({ id: 1, fieldName: 'accountname' });

Create an account with the Batch API

const tenant = corsair.withTenant('acme');
await tenant.fireberry.api.batch.create({
	objectCode: 'account',
	data: [{ accountname: 'Example Company' }],
});

See the full list on the API page.

What’s next

API reference

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