TriggerResponse

Type: TriggerResponse

TriggerResponse has 2 top-level fields. Fields typed as another schema link to that schema's page, and nested objects expand in place below. It is referenced by 1 operation, listed under Used by. The machine-readable definition is #/components/schemas/TriggerResponse in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

data ExecutionSummary The shape returned by `triggerWorkflow`. Compared with `Execution` it carries `execution_mode` and never `assigned_to_user_id`.

Schema: ExecutionSummary
- id integer required
- object string required
- workflow_id integer required
- status string required Lifecycle of an execution. `queued` (batch rows not yet dispatched), `pending`, `running` and `waiting` (paused on a Wait node or adverse-action waiting period) are in flight; `awaiting_review` is paused on human review; `completed`, `failed`, `cancelled` and `skipped` are terminal. One of queued pending running waiting awaiting_review completed failed cancelled skipped
- execution_mode string One of test live
- execution_key string, nullable The namespaced idempotency key (`api_client:<id>:<Idempotency-Key>`).
- external_reference string, nullable
- needs_human_review boolean required
- review_status string required One of none in_review approved denied
- started_at string (date-time), nullable
- completed_at string (date-time), nullable
- created_at string (date-time) required
- updated_at string (date-time), nullable
meta Meta

Schema: Meta
- request_id string required Correlation id for this request. Also sent as the `X-Request-Id` response header; quote it when contacting support.

Used by

POST /workflows/{id}/trigger Trigger a workflow