Sign in to run requests with your own sandbox key. Sign in

ExecutionSummary

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

Type: ExecutionSummary

ExecutionSummary has 13 top-level fields; id, object, workflow_id, status, needs_human_review, review_status, created_at are always present. Fields typed as another schema link to that schema's page, and nested objects expand in place below. The machine-readable definition is #/components/schemas/ExecutionSummary in openapi.json; the example in the right-hand rail is synthesized from the field examples in that spec.

Fields

  • 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
Was this page helpful?