Northwind
Home / Docs

Build on Northwind.

Design, run, and govern workflows programmatically — with a REST API and a typed SDK for the systems that are uniquely yours.

Quickstart

Authenticate, trigger a workflow, and read its run — in three calls.

1 · Get a key

Create an API key scoped to your workspace.

2 · Trigger

Start a workflow run with a typed payload.

3 · Observe

Poll the run or subscribe to a webhook.

workflow.ts
import { Northwind } from '@northwind/sdk';

const nw = new Northwind({ apiKey: process.env.NW_KEY });

// trigger a governed workflow
const run = await nw.workflows.trigger('procurement-approval', {
  vendor: 'Acme Corp', amount: 4200, class: 'OPEX',
});

const status = await nw.runs.get(run.id);
console.log(status.state); // "in_review"

Core endpoints

POST/v1/workflows/:id/triggerStart a run
GET/v1/runs/:idFetch run status & history
GET/v1/connectorsList managed connectors
POST/v1/webhooksSubscribe to run events
GET/v1/auditExport the immutable audit log