Workflow Runs - incident.io

Getting started

Webhooks

Audit logs

Deprecated endpoints

The workflow run object

created_at

string<date-time>

required

When the resource was created

Example:

"2021-08-17T13:28:57.801578Z"

string

required

Unique identifier for the workflow run

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

progress

object[]

required

Status of each step as it is worked

Show child attributes

Example:

[
  {
    "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

string<date-time>

required

When the run was scheduled for

Example:

"2021-08-17T13:28:57.801578Z"

updated_at

string<date-time>

required

When the resource was last updated

Example:

"2021-08-17T13:28:57.801578Z"

workflow_id

string

required

Unique identifier for the underlying workflow

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

workflow_version_id

string

required

Unique identifier of the workflow version

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

workflow_version_number

integer<int64>

required

Monotonically incrementing version number for the version that ran

Example:

3

cancelled_at

string<date-time>

If the run was cancelled, this is when

Example:

"2021-08-17T13:28:57.801578Z"

enqueued_at

string<date-time>

When the run was enqueued for execution

Example:

"2021-08-17T13:28:57.801578Z"

error

string

Error produced by the workflow, if it failed

Example:

"Something went wrong and our engineers have been notified."

incident_id

string

If this run was against a specific incident, this is the ID of that incident

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

incident_reference

string

If this run was against a specific incident, this is the reference of that incident

Example:

"INC-123"

workflow_name

string

Name of the underlying workflow

Example:

"Announce incident updates"

{
  "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"
}