Escalations

Create and manage escalation paths, and create, list, filter and respond to escalations. With incident.io On-call you can create escalation paths that describe how a page should be escalated to people and schedules.

The escalation object

created_at

string<date-time>

required

When this escalation was created

Example:

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

creator

object

required

The creator of this escalation. Can be a user, a workflow, or an alert. If the escalation came from a call route, this will be empty.

Show child attributes

Example:

{
  "alert": {
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "title": "*errors.withMessage: PG::Error failed to connect"
  },
  "user": {
    "email": "lisa@incident.io",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Lisa Karlin Curtis",
    "role": "owner",
    "slack_user_id": "U02AYNF2XJM"
  },
  "workflow": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "My little workflow"
  }
}

description

string

required

Additional detail provided with this escalation. When it isn't set explicitly, this is taken from the alert description or the incident summary, and is empty when neither applies.

Example:

"Database CPU has been above 90% for 5 minutes"

events

object[]

required

Events which describe the history of this escalation. Events include information about what users or channels were notified and what users acked.

Show child attributes

Example:

[
  {
    "channels": [
      {
        "microsoft_teams_channel_id": "abc123",
        "microsoft_teams_team_id": "abc123",
        "slack_channel_id": "abc123",
        "slack_team_id": "abc123"
      }
    ],
    "event": "entered_grace_period",
    "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
    "occurred_at": "2021-08-17T13:28:57.801578Z",
    "urgency": "high",
    "users": [
      {
        "email": "lisa@incident.io",
        "id": "01FCNDV6P870EA6S7TK1DSYDG0",
        "name": "Lisa Karlin Curtis",
        "role": "owner",
        "slack_user_id": "U02AYNF2XJM"
      }
    ]
  }
]

string

required

Unique ID of the escalation

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

priority

object

required

The priority associated with this escalation.

Show child attributes

Example:

{ "name": "P1" }

Alerts related to this escalation

Show child attributes

Example:

[
  {
    "alert_group_ids": ["01GW2G3V0S59R238FAHPDS1R66"],
    "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
    "created_at": "2021-08-17T13:28:57.801578Z",
    "deduplication_key": "4293868629",
    "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "resolved_at": "2021-08-17T14:28:57.801578Z",
    "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
    "status": "firing",
    "title": "*errors.withMessage: PG::Error failed to connect",
    "updated_at": "2021-08-17T13:28:57.801578Z"
  }
]

Incidents related to this escalation

Show child attributes

Example:

[
  {
    "external_id": 123,
    "id": "01FDAG4SAP5TYPT98WGR2N7W91",
    "name": "Our database is sad",
    "reference": "INC-123",
    "status_category": "triage",
    "summary": "Our database is really really sad, and we don't know why yet.",
    "visibility": "public"
  }
]

status

enum<string>

required

Status of the escalation

Available options:

pending,

triggered,

acked,

resolved,

expired,

cancelled,

snoozed,

delayed,

pending_repeat

Example:

"pending"

title

string

required

The title of this escalation

Example:

"Database CPU is high"

updated_at

string<date-time>

required

When this escalation was last updated

Example:

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

escalation_path_id

string

Unique identifier of the escalation path that the escalation was created from

Example:

"01G0J1EXE7AXZ2C93K61WBPYEH"

{
  "created_at": "2021-08-17T13:28:57.801578Z",
  "creator": {
    "alert": {
      "id": "01GW2G3V0S59R238FAHPDS1R66",
      "title": "*errors.withMessage: PG::Error failed to connect"
    },
    "user": {
      "email": "lisa@incident.io",
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "Lisa Karlin Curtis",
      "role": "owner",
      "slack_user_id": "U02AYNF2XJM"
    },
    "workflow": {
      "id": "01FCNDV6P870EA6S7TK1DSYDG0",
      "name": "My little workflow"
    }
  },
  "description": "Database CPU has been above 90% for 5 minutes",
  "events": [
    {
      "channels": [
        {
          "microsoft_teams_channel_id": "abc123",
          "microsoft_teams_team_id": "abc123",
          "slack_channel_id": "abc123",
          "slack_team_id": "abc123"
        }
      ],
      "event": "entered_grace_period",
      "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
      "occurred_at": "2021-08-17T13:28:57.801578Z",
      "urgency": "high",
      "users": [
        {
          "email": "lisa@incident.io",
          "id": "01FCNDV6P870EA6S7TK1DSYDG0",
          "name": "Lisa Karlin Curtis",
          "role": "owner",
          "slack_user_id": "U02AYNF2XJM"
        }
      ]
    }
  ],
  "id": "01G0J1EXE7AXZ2C93K61WBPYEH",
  "priority": {
    "name": "P1"
  },
  "related_alerts": [
    {
      "alert_group_ids": [
        "01GW2G3V0S59R238FAHPDS1R66"
      ],
      "alert_source_id": "01GW2G3V0S59R238FAHPDS1R66",
      "created_at": "2021-08-17T13:28:57.801578Z",
      "deduplication_key": "4293868629",
      "description": "CPU on the payments service has exceeded 75 percent for 5 minutes",
      "id": "01GW2G3V0S59R238FAHPDS1R66",
      "resolved_at": "2021-08-17T14:28:57.801578Z",
      "source_url": "https://www.my-alerting-platform.com/alerts/my-alert-123",
      "status": "firing",
      "title": "*errors.withMessage: PG::Error failed to connect",
      "updated_at": "2021-08-17T13:28:57.801578Z"
    }
  ],
  "related_incidents": [
    {
      "external_id": 123,
      "id": "01FDAG4SAP5TYPT98WGR2N7W91",
      "name": "Our database is sad",
      "reference": "INC-123",
      "status_category": "triage",
      "summary": "Our database is really really sad, and we don't know why yet.",
      "visibility": "public"
    }
  ],
  "status": "pending",
  "title": "Database CPU is high",
  "updated_at": "2021-08-17T13:28:57.801578Z",
  "escalation_path_id": "01G0J1EXE7AXZ2C93K61WBPYEH"
}

Getting started

Webhooks

Audit logs

Deprecated endpoints

The escalation object

​The escalation object

The escalation object