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

Execution

The list/detail shape returned by the `/executions` endpoints.

Type: Execution

Execution 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. It is referenced by 6 operations, listed under Used by. The machine-readable definition is #/components/schemas/Execution 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_key string, nullable
  • external_reference string, nullable
  • needs_human_review boolean required
  • review_status string required One of none in_review approved denied
  • assigned_to_user_id integer, nullable The reviewer who claimed this execution, if any.
  • started_at string (date-time), nullable
  • completed_at string (date-time), nullable
  • created_at string (date-time) required
  • updated_at string (date-time), nullable

Used by

Was this page helpful?