Remarkety plugin

• rules.list gives every rule type, keyed by type (CART_FOLLOWUP_TIME, …), with its operators, possibleValues and defaultValue. A campaign action’s rules must use those exact operator strings.
• campaigns.types gives the campaign types the store supports (TRIGGER_CART_RECOVERY, …) with their mandatory and optional rules.

• contacts.create emails the contact by default. Remarkety’s doubleOptin defaults to true and sends a confirmation request; pass doubleOptin: false to add a contact without it. properties is one object, not a list.
• stores.create and stores.update carry a different secret. The apiKey there is the key Remarkety uses to sync that store; it is not the token this plugin authenticates with.
• stores.update is PUT /stores with the id in the body, not PUT /stores/{id}. The same is true of campaigns.update, which is PUT /stores/{storeId}/campaigns.
• mode decides whether a campaign sends. run starts it contacting shoppers, test sends a sample to testEmail, and stop halts it. Check the current mode with campaigns.get before updating, and remember a stop is the safe state to build in.
• An email action needs a subject and a baseTemplate; an api action needs a webhook. The plugin rejects either omission rather than creating a campaign Remarkety cannot run. This endpoint version expects exactly one action.
• stores.status is the sync health check, and syncStatus is the field to read. syncLastError holds the last runner message even on a healthy store (for example Campaign runner completed ( success: 0 ) with syncStatus: OK), so a non-empty value is not a failure.
• Deleting a store is destructive and final. There is no archive state, and a store’s campaigns and contacts go with it.

• 20 typed API operations

​

Setup

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

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

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

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

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

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

remarkety()

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

​

Example API calls

const tenant = corsair.withTenant('acme');
await tenant.remarkety.api.rules.list({ storeId: 'AbC123xy' });

const tenant = corsair.withTenant('acme');
await tenant.remarkety.api.contacts.create({
	storeId: 'AbC123xy',
	email: 'jane@example.com',
	firstName: 'Jane',
	allowedMarketing: true,
});

​

What’s next