Rippling: Execute a workflow — response body
Execute a workflow: response body. Complete fields and constraints for contract 2026-10-28.
API reference · Contract 2026-10-28
SDK schema: Execute a workflow — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | A single execution of a workflow: one launch of the workflow’s current published version, with a status to poll until it reaches a terminal value. Additional keys: not allowed |
created_at | string | Required within parent | When the workflow was launched, in UTC (ISO 8601). Format: date-time |
id | string | Required within parent | Unique identifier for this workflow execution. Poll it with GET /workflows/{id}/executions/{execution_id}. |
status | string | Required within parent | The execution status. Transitional values are `pending`, `in_progress`, `waiting_for_response`, and `cancellation_pending`; terminal values are `completed`, `failed`, and `cancelled`. Poll until the status reaches a terminal value. * `pending`: The execution is queued and has not started. * `in_progress`: The workflow is executing. * `waiting_for_response`: The execution is paused on a human input or approval step. * `cancellation_pending`: A cancellation was requested and is being applied. * `completed`: Every step finished successfully. * `failed`: The execution stopped on an error. * `cancelled`: The execution was cancelled before completing. * `unknown`: The status could not be mapped. Contact support if this persists. Known values: pending, in_progress, completed, failed, cancelled, cancellation_pending, waiting_for_response, unknown |
version_id | string | Required within parent | The workflow version that ran. An execution always runs the workflow’s current published version; the current version_id is available from GET /workflows/{id}. |
workflow_id | string | Required within parent | The ID of the workflow this execution belongs to. Matches the {id} path parameter. |