Overview - Corsair

Use Wix through Corsair: one client, typed API calls, local DB sync. What you get:

143 typed API operations
19 synced entities (bookingCategories, brands, campaigns, contacts, coupons, currencies, and 13 more) for fast .search() / .list()

Setup

Install

npm install corsair @corsair-dev/wix

yarn add corsair @corsair-dev/wix

pnpm install corsair @corsair-dev/wix

bun add corsair @corsair-dev/wix

Add the plugin

corsair.ts

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

export const corsair = createCorsair({
	plugins: [
		wix(),
	],
	database: new Database('corsair.db'),
	kek: process.env.CORSAIR_KEK!,
	hub: {
		projectApiKey: process.env.CORSAIR_API_KEY!,
		signingSecret: process.env.CORSAIR_SIGNING_SECRET!,
	},
});

Multi-tenancy is the default — scope calls with corsair.withTenant(id). See Quick start for KEK + Hub keys, and Multi-tenancy for account isolation.

Choose authentication

OAuth 2.0 (Recommended)
API Key

Open hub.corsair.dev, navigate to your project, and enter the client ID and client secret from your Wix OAuth app.

wix()

More: OAuth 2.0

No setup required yet. When you make your first request as a tenant, Corsair prompts for the API key.

wix({
	authType: 'api_key',
})

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

Example API calls

billing.listDefaultTaxGroups

const tenant = corsair.withTenant('acme');
await tenant.wix.api.billing.listDefaultTaxGroups({});

automations.bulkUpdateStorageItemTags

const tenant = corsair.withTenant('acme');
await tenant.wix.api.automations.bulkUpdateStorageItemTags({});

See the full list on the API page.

Query synced data

Synced entities support tenant.wix.db.<entity>.search() and .list(): bookingCategories, brands, campaigns, contacts, coupons, currencies, customFields, extendedBookings, forms, formSubmissions, groupRequests, inventoryItems, locations, manualTaxMappings, moderationRules, orders, products, siteFolders, taxGroups. See Database for filters and operators.

What’s next

API reference

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

Database

Synced entities, search filters, and operators.

Connect / OAuth

createLink, Hub delivery, and tenant connect flows.

Use with agents

Expose this plugin’s operations as MCP tools.

​Setup

​Example API calls

​Query synced data

​What’s next