Guide

Zapier and Make

Start a coworker's work from a no-code automation. There is no Synthia Agents app to install in Zapier or Make: both platforms' own generic HTTP and webhook modules call your deployment directly, with one of the two credentials below.

6 min read

Two ways inCopy link to this section

WayRequestCredentialUse it when
A. Run a routine nowPOST /api/routines/{id}/runAn API key with the write:routines scopeThe routine's own instruction is the whole job, and the automation only decides when it runs.
B. Call a webhook triggerPOST /api/events/triggers/{id}The trigger's own key, sent as Authorization: BearerYou want to send data along, or you would rather not give the automation an API key. The key opens that one trigger and nothing else.

Both are plain HTTPS POST requests to your deployment's address, and neither needs a signed-in browser. The trigger address is one of the few inbound webhook paths your workspace admits without a sign-in, because the trigger checks its key itself; everything else still needs a sign-in.

A. Run a routine with an API keyCopy link to this section

  1. In the workspace open Settings › API keys and create a key with the scopes read:routines and write:routines. Copy it when it is shown; it is shown once. (read:routines is only for looking up the routine's id below.)
  2. Find the routine's id: the call below lists your routines.
  3. In Zapier or Make, add an HTTP step that sends POST to the run address with the header Authorization: Bearer and your key. No body is needed.
read -rs api_key && export api_key
export workspace="https://<your-deployment>"

curl -sS -H "Authorization: Bearer $api_key" \
  "$workspace/api/routines"

export routine_id="<the routine id>"
curl -sS -X POST -H "Authorization: Bearer $api_key" \
  "$workspace/api/routines/$routine_id/run"

The answer is 202 with {"accepted": true, "runId": "…"}: the run has started, not finished. Its progress is in the routine's history in the app, or from GET /api/routines/{id}/runs. A 401 means the key is missing, mistyped, revoked or expired; a 403 that it lacks write:routines.

The same request as the fields an HTTP module asks for:

{
  "method": "POST",
  "url": "https://<your-deployment>/api/routines/<routine id>/run",
  "headers": {
    "Authorization": "Bearer <your API key>"
  }
}

B. Call a webhook triggerCopy link to this section

  1. Add a Webhook trigger: on a routine, open Routines › Triggers › Add trigger; on a responsibility, add it in the responsibility's triggers.
  2. Copy the address with Copy URL, then press Show key and Copy header. The header is Authorization: Bearer whsec_…. Keep it like a password; Rotate key replaces it.
  3. Send a JSON object (or an empty body) to the address with that header.
export trigger_url="https://<your-deployment>/api/events/triggers/<trigger id>"
read -rs trigger_key && export trigger_key

curl -sS -X POST \
  -H "Authorization: Bearer $trigger_key" \
  -H "content-type: application/json" \
  -H "Idempotency-Key: form-response-1042" \
  -d '{"type":"form.submitted","name":"Aiko Tanaka","email":"aiko@example.com","message":"Can we book a demo next week?"}' \
  "$trigger_url"

The body on its own, as you would paste it into an HTTP module's request content:

{
  "type": "form.submitted",
  "name": "Aiko Tanaka",
  "email": "aiko@example.com",
  "message": "Can we book a demo next week?"
}
AnswerMeaning
200"accepted": true. With "queued": true a run was queued (queued, not finished); with "queued": false the reason says why nothing ran, for example a filter that did not match. "duplicate": true means the same event arrived before.
401The key is missing or wrong.
409The trigger, its routine or its responsibility is paused.
413The body is larger than 256 KB.
429More than 120 requests a minute from one sending address to this path. Wait a minute.
503The trigger has no key yet, or the deployment is still starting. Try again shortly.

type (or event) names the event, and is what a trigger's filter matches; without one it is received. Idempotency-Key (up to 200 characters) makes a retry safe: the same key twice is one event, so set it to the id of the record that started the automation.

What the data does: on a routine, the trigger starts the routine and the routine follows its own instruction, whatever the body says. On a responsibility, the run is given the event, so the coworker can work with the fields you send.

If your automation can compute an HMAC, it can sign instead of sending the key: the Standard Webhooks headers webhook-id, webhook-timestamp and webhook-signature, signed with the trigger's key, are accepted within 5 minutes of their timestamp.

Ready-made recipesCopy link to this section

Three automations to rebuild step by step. Module names are the ones Zapier and Make show today; they may move in their menus.

1. Zapier: a new form response, followed up by a coworkerCopy link to this section

  1. In the workspace, create a responsibility such as "Reply to every new enquiry within the hour", and add a Webhook trigger to it. Copy its URL and header.
  2. In Zapier, create a Zap. Trigger: your form app's new-response event (for example Google Forms New Form Response or Typeform New Entry).
  3. Action: Webhooks by Zapier, event POST. URL: the trigger URL. Payload Type: json. Data: type = form.submitted, then name, email and message mapped from the form's fields.
  4. Headers: Authorization = Bearer whsec_… (the key), and Idempotency-Key = the form response's id.
  5. Test the step. Zapier should show 200 with "accepted": true, and the run appears on the responsibility.

2. Make: a deal marked won starts the onboarding routineCopy link to this section

  1. In the workspace, create a routine whose instruction is the onboarding kickoff, and create an API key with write:routines. Note the routine's id.
  2. In Make, create a scenario. First module: your CRM's watch-deals (or updated-record) module.
  3. Add a filter after it: continue only when the deal's stage is won.
  4. Next module: HTTP › Make a request. URL: https://<your-deployment>/api/routines/<routine id>/run. Method: POST. Header: Authorization = Bearer <your API key>. No body.
  5. Run once. Make should show status 202, and the run appears in the routine's history.

3. Make or Zapier: each new spreadsheet row, triaged by a coworkerCopy link to this section

  1. Create a responsibility such as "Triage each new request in the intake sheet" with a Webhook trigger. Optionally give the trigger a filter on type = row.added.
  2. Trigger: Google Sheets Watch Rows in Make, or New Spreadsheet Row in Zapier.
  3. Action: Make's HTTP › Make a request (body type raw, content type JSON) or Zapier's Webhooks by Zapier › Custom Request, method POST, to the trigger URL with the Authorization header, and this body with the row's columns mapped in:
{
  "type": "row.added",
  "sheet": "Intake",
  "row": 57,
  "request": "Laptop for the new designer",
  "requested_by": "kenji@example.com"
}

Set Idempotency-Key to the sheet name and row number (for example Intake-57), so a re-run of the scenario does not triage the same row twice.

Looking after the credentialsCopy link to this section

Keep the key in Zapier's or Make's stored connection or header field, not in a step's visible text. Prefer a trigger key over an API key when the automation only needs to start one thing: a trigger key opens nothing else. If one leaks, rotate the trigger's key, or revoke the API key in Settings › API keys; the automation stops working until you paste the new one.

← Developer docs

Last updated