Incident Updates

API endpoints for incident updates

List incident updates.

Incident Updates allows you to see all the updates that have been shared against a particular incident. This will include any time that the Severity or Status of an incident changed, alongside any additional updates that were provided.

The incident update object

created_at · string<date-time> · required

When the update was created

Example:

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

id · string · required

Unique identifier for this incident update

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

incident_id · string · required

The incident this update relates to

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

new_incident_status · object · required

Show child attributes

Example:

{
  "category": "triage",
  "created_at": "2021-08-17T13:28:57.801578Z",
  "description": "Impact has been **fully mitigated**, and we're ready to learn from this incident.",
  "id": "01FCNDV6P870EA6S7TK1DSYD5H",
  "name": "Closed",
  "rank": 4,
  "updated_at": "2021-08-17T13:28:57.801578Z"
}

updater · object · required

Show child attributes

Example:

{
  "alert": {
    "id": "01GW2G3V0S59R238FAHPDS1R66",
    "title": "*errors.withMessage: PG::Error failed to connect"
  },
  "api_key": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "My test API key"
  },
  "user": {
    "email": "[e-mail]",
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "Lisa Karlin Curtis",
    "role": "owner",
    "slack_user_id": "U02AYNF2XJM"
  },
  "workflow": {
    "id": "01FCNDV6P870EA6S7TK1DSYDG0",
    "name": "My little workflow"
  }
}

merged_into_incident_id · string

The ID of the incident this incident was merged into, if the to state of this update is 'merged'.

Example:

"01FCNDV6P870EA6S7TK1DSYDG0"

message · string

Message that explains the context behind the update

Example:

"We're working on a fix, hoping to ship in the next 30 minutes"

new_severity · object

Show child attributes

Example:

{
  "created_at": "2021-08-17T13:28:57.801578Z",
  "description": "Issues with **low impact**.",
  "id": "01FCNDV6P870EA6S7TK1DSYDG0",
  "name": "Minor",
  "rank": 1,
  "updated_at": "2021-08-17T13:28:57.801578Z"
}