TextIt plugin

• Sending messages and broadcasts and starting flows can contact real people. Bulk contact and message actions include permanent deletion.
• Campaign, campaign event and field updates replace the record, so they need the same fields as a create (TextIt answers 400 otherwise). A group used by a campaign can’t be deleted until the campaign is archived in TextIt.
• Message actions apply only to incoming messages and take the integer id that messages.list returns.
• Updating a contact by URN creates it if the URN is unknown. messageActions.apply returns undefined on complete success or an object { failures: [...] } when some messages could not be updated; access the failed IDs through result.failures.
• Upload media with a Blob using media.upload; its UUID can be used in message attachments.
• Rate-limited requests are retried up to three times, waiting for TextIt’s Retry-After. Other failures throw Corsair’s ApiError with the HTTP status and TextIt’s error body; the default handlers do not replay writes.
• Outbound resthook subscription management is supported; inbound webhook verification is not included.
• The provider’s globals create example uses /global.json, which currently returns 404; the indexed plural /globals.json route is used. Its subscriber ID prose says integer while examples show strings, so both are accepted.

• 49 typed API operations

Setup

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

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

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

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

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

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

textit()

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

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.textit.api.archives.list({});

const tenant = corsair.withTenant('acme');
await tenant.textit.api.broadcasts.send({
	contacts: ['09d23a05-47fe-11e4-bfe9-b8f6b119e9ab'],
	text: { eng: 'Hello!' },
});

What’s next