Overview

• Paging is by page number. Pass page; the response carries page_size, page_count and total_count. channels.list sends only total_count, so read channels.length for that route.
• Three routes answer a bare array, not a wrapper: contact notes, incidents and systems. The plugin wraps each under a named key (notes, incidents, systems) so a caller always reads a collection, and a non-array body throws instead of becoming an empty list.
• Report payloads are maps, not arrays. reports.volume keys conversation counts by YYYY-MM-DD, reports.tags keys tag counts by tag name, reports.staff keys metrics by staff display name, and reports.channelSummary keys them by channel id. Read them with Object.entries.
• Conversation status is an integer: 0 open, 1 responded, 2 done, 3 spam, 4 archived, 5 on hold, 6 auto-done, 7 and 8 for the AI agent, 9 AI spam.
• Request bodies are wrapped, in conversation, message, contact, identity, article, incident, response_template or staff. Notes are the exception: notes.create and notes.update send the fields unwrapped, as a bare { body } plus the optional creator_email and created_at.
• incidents.update is a PUT. The vendor heading says PUT and its curl example sends -X POST; the route only answers PUT, so that is what the endpoint sends.
• An unknown route answers HTML, not JSON. An unknown resource answers {"errors":"Not Found"}, an unknown route {"status":404,"error":"Not Found"}, and a validation failure a map of field to message with status 422.

• 38 typed API operations

​

Setup

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

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

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

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

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

export const corsair = createCorsair({
	plugins: [
		reamaze(),
	],
	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!,
	},
});

reamaze()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.reamaze.api.conversations.list({ page: 1 });

const tenant = corsair.withTenant('acme');
await tenant.reamaze.api.messages.create({ slug: 'knock-knock', body: 'Thanks for reaching out, we are looking into this now.', visibility: 0 });

​

What’s next