Start a run from Zapier, Make or n8n

Zapier, Make and n8n can each send an HTTP request as a step: Zapier's Webhooks by Zapier → POST, Make's HTTP → Make a request, n8n's HTTP Request node. That one step can start a SynapseOrch workflow — a new order in your shop starts Log new orders, a form submission starts Answer a customer question — and hand it what the trigger received.

What you need

• An API key. On Cloud, under Settings → Developer (owners and admins make keys); self-hosted, under Settings → API keys. Name it after the tool that will use it, so it is plain in the list what to revoke. See API keys.
• The workflow's id, from its row's menu on the Workflows page, or GET /api/v2/orchestrations.
• An address the tool can reach. On Cloud that is https://api.synapseorch.com. A self-hosted install must be reachable from the tool: Zapier and Make call from the internet, so they need a public https address; an n8n running beside your install can call it directly.

The request

Every tool needs the same four things:

For example, from a new-order trigger:

{
  "message": "Order 5312 from Fenwick & Co",
  "initial_state": { "order": { "number": "5312", "customer": "Fenwick & Co", "total": 1840.00 } }
}

Map the trigger's fields into the body in each tool's own way. Keep the key in the tool's secret or credential store rather than typed into the step.

A short workflow or a long one

/api/v2/…/run answers at once, with the run_id, while the run works (queued with its place in line if every slot is busy). Use it for anything that takes more than a few seconds: Zapier and Make stop waiting for an answer well before a long run ends. To get the result back, add webhook_url to the body — a Zapier Catch Hook, a Make Custom webhook or an n8n Webhook node's address — and SynapseOrch posts the outcome there when the run ends; add webhook_secret to have it signed (see Webhooks). On Cloud the address must be public https.

/api/v1/orchestrations/<workflow-id>/run waits for the run to finish or stop for a person, and answers with its response. It suits a workflow that finishes in seconds, where the next step of the zap or scenario needs the answer. A run that pauses for a person answers paused, with its question; answer it in the app, or with resume.

A self-hosted install serves /api/v2 in scale mode; without it, use /api/v1.

What it costs

A run started this way is an ordinary run: in Runs, scored if the workflow has a rubric, and on Cloud charged as any run is. Each call also counts as a task, or an operation, in the other tool's own plan.

See The public API for following a run's status and stream, and the Workflows API for every field.