Workflow Runs
API endpoints for workflow runs
The workflow run object
When the resource was created
"2021-08-17T13:28:57.801578Z"
Unique identifier for the workflow run
"01FCNDV6P870EA6S7TK1DSYDG0"
Status of each step as it is worked
Show child attributes
Show child attributes
[
{
"completed_at": "2021-08-17T13:28:57.801578Z",
"error": "Something went wrong and our engineers have been notified.",
"incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_reference": "INC-123",
"status": "complete",
"step": "slack.post_message",
"webhook_delivery": {
"duration_ms": 412,
"endpoint": "https://example.com/hooks/incident",
"method": "POST",
"outcome": "non_2xx",
"request": {
"body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}",
"body_truncated": false,
"headers": { "Content-Type": "application/json" }
},
"response": {
"body": "{\"error\":\"unprocessable\"}",
"body_truncated": false,
"headers": { "Content-Type": "application/json" }
},
"status_code": 500
},
"webhook_delivery_state": "expired"
}
]
When the run was scheduled for
"2021-08-17T13:28:57.801578Z"
When the resource was last updated
"2021-08-17T13:28:57.801578Z"
Unique identifier for the underlying workflow
"01FCNDV6P870EA6S7TK1DSYDG0"
Unique identifier of the workflow version
"01FCNDV6P870EA6S7TK1DSYDG0"
Monotonically incrementing version number for the version that ran
3
If the run was cancelled, this is when
"2021-08-17T13:28:57.801578Z"
When the run was enqueued for execution
"2021-08-17T13:28:57.801578Z"
Error produced by the workflow, if it failed
"Something went wrong and our engineers have been notified."
If this run was against a specific incident, this is the ID of that incident
"01FCNDV6P870EA6S7TK1DSYDG0"
If this run was against a specific incident, this is the reference of that incident
"INC-123"
Name of the underlying workflow
"Announce incident updates"
Was this page helpful?
{
"created_at": "2021-08-17T13:28:57.801578Z",
"id": "01FCNDV6P870EA6S7TK1DSYDG0",
"progress": [
{
"completed_at": "2021-08-17T13:28:57.801578Z",
"error": "Something went wrong and our engineers have been notified.",
"incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_reference": "INC-123",
"status": "complete",
"step": "slack.post_message",
"webhook_delivery": {
"duration_ms": 412,
"endpoint": "https://example.com/hooks/incident",
"method": "POST",
"outcome": "non_2xx",
"request": {
"body": "{\"incident_id\":\"01FCNDV6P870EA6S7TK1DSYDG0\"}",
"body_truncated": false,
"headers": {
"Content-Type": "application/json"
}
},
"response": {
"body": "{\"error\":\"unprocessable\"}",
"body_truncated": false,
"headers": {
"Content-Type": "application/json"
}
},
"status_code": 500
},
"webhook_delivery_state": "expired"
}
],
"scheduled_at": "2021-08-17T13:28:57.801578Z",
"updated_at": "2021-08-17T13:28:57.801578Z",
"workflow_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"workflow_version_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"workflow_version_number": 3,
"cancelled_at": "2021-08-17T13:28:57.801578Z",
"enqueued_at": "2021-08-17T13:28:57.801578Z",
"error": "Something went wrong and our engineers have been notified.",
"incident_id": "01FCNDV6P870EA6S7TK1DSYDG0",
"incident_reference": "INC-123",
"workflow_name": "Announce incident updates"
}