Workflow runs API reference
Complete reference documentation for the Workflow runs resource.
Workflow runs
#A workflow run represents an individual execution of a workflow for a specific recipient. Use the workflow runs API to inspect the status and event history of a workflow run, including which steps were executed and any errors encountered.
List workflow recipient runs
#Returns a paginated list of workflow recipient runs for the current environment.
Endpoint
Query parameters
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of items per page (defaults to 50).
Limits the results to workflow recipient runs for the given workflow key.
Limits the results to workflow recipient runs with the given status.
Limits the results to workflow recipient runs for the given tenant.
Limits the results to workflow recipient runs that have errors.
Limits the results to workflow recipient runs for the given recipient. Accepts a user ID string or an object reference with id and collection.
Limits the results to workflow recipient runs started after the given date.
Limits the results to workflow recipient runs started before the given date.
Returns
A paginated list of workflow recipient runs.
A list of workflow recipient runs.
The typename of the schema.
The number of errors encountered during the workflow recipient run.
The unique identifier for the workflow recipient run (per-recipient).
Timestamp when the resource was created.
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
The current status of the workflow recipient run. One of queued, processing, paused, completed, or cancelled.
The tenant associated with the workflow recipient run.
Describes how the workflow was triggered.
The key of the audience that triggered the workflow.
The cancellation key provided when the workflow was triggered via the API.
The ID of the schedule that triggered the workflow.
The type of trigger source. One of api, audience, schedule, broadcast, workflow_step, integration, or rehearsal.
The timestamp when the resource was last updated.
The key of the workflow that was executed.
The identifier for the top-level workflow run shared across all recipients in a single trigger.
Pagination information for a list of resources.
The typename of the schema.
The cursor to fetch entries after.
The cursor to fetch entries before.
The number of items per page (defaults to 50).
Get a workflow recipient run
#Returns a single workflow recipient run with its associated events.
Endpoint
Path parameters
The unique identifier for the workflow recipient run (per-recipient).
Returns
A workflow recipient run represents an individual execution of a workflow for a specific recipient.
The typename of the schema.
The number of errors encountered during the workflow recipient run.
The unique identifier for the workflow recipient run (per-recipient).
Timestamp when the resource was created.
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
The current status of the workflow recipient run. One of queued, processing, paused, completed, or cancelled.
The tenant associated with the workflow recipient run.
Describes how the workflow was triggered.
The key of the audience that triggered the workflow.
The cancellation key provided when the workflow was triggered via the API.
The ID of the schedule that triggered the workflow.
The type of trigger source. One of api, audience, schedule, broadcast, workflow_step, integration, or rehearsal.
The timestamp when the resource was last updated.
The key of the workflow that was executed.
The identifier for the top-level workflow run shared across all recipients in a single trigger.
WorkflowRecipientRun
#A workflow recipient run represents an individual execution of a workflow for a specific recipient.
Attributes
The typename of the schema.
The number of errors encountered during the workflow recipient run.
The unique identifier for the workflow recipient run (per-recipient).
Timestamp when the resource was created.
A reference to a recipient, either a user identifier (string) or an object reference (ID, collection).
The current status of the workflow recipient run. One of queued, processing, paused, completed, or cancelled.
The tenant associated with the workflow recipient run.
Describes how the workflow was triggered.
The key of the audience that triggered the workflow.
The cancellation key provided when the workflow was triggered via the API.
The ID of the schedule that triggered the workflow.
The type of trigger source. One of api, audience, schedule, broadcast, workflow_step, integration, or rehearsal.
The timestamp when the resource was last updated.
The key of the workflow that was executed.
The identifier for the top-level workflow run shared across all recipients in a single trigger.
WorkflowRecipientRunDetail
#A single workflow recipient run with its events.
Attributes
A single workflow recipient run with its events.
WorkflowRecipientRunEvent
#An event that occurred during a workflow recipient run.
Attributes
The typename of the schema.
The attempt number of the workflow recipient run event. Increments for each retry.
Event-specific data associated with the event.
The type of event that occurred.
The unique identifier for the event.
Timestamp when the resource was created.
Whether the event represents a successful or error state.
The reference of the workflow step associated with this event.
The type of workflow step associated with this event.