Inbound webhooks

Routes are relative to <PUBLIC_BASE_URL>; request and response bodies are JSON unless stated otherwise. Authentication, scopes, pagination and the error format are described in the REST API guides.

POST /hooks/wf/{token}

Trigger a workflow by webhook

The entry point of the webhook trigger. The token is the one returned by POST /api/v1/workflows/{id}/webhook; the JSON body becomes the trigger data of a real execution. Rate-limited per IP.

Access — Authorised by the token carried in the URL.

Parameters

Name	In	Type	Required
token	path	string	yes

Request body (application/json)

Type : object

{
  "type": "object",
  "propertyNames": { "type": "string" },
  "additionalProperties": {}
}

Responses

202 — Execution created.

Field	Type	Required
executionId	string	yes

JSON Schema

{
  "type": "object",
  "properties": { "executionId": { "type": "string" } },
  "required": [ "executionId" ],
  "additionalProperties": false
}

400 — The request does not match its schema.