Incident Updates API Reference

Get an incident update

Endpoint:

GET /v1/:page_id/incidents/:incident_id/incident-updates/:incident_update_id

Example response

{
"id": "ckf1ew8mol30c0a32w400k6s3",
"message": "We're currently investigating an issue with the Website",
"messageHtml": "<p>We're currently investigating an issue with the Website</p>",
"status": "INVESTIGATING",
"notify": true,
"started": "2020-09-12T03:38:47.998Z",
"incident": {
"id": "ckf01m59ueaqb0a32wrljz1yd",
"name": "Rocket is going down",
"started": "2020-09-12T19:05:17.398Z",
"status": "INVESTIGATING",
"components": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"showUptime": true,
"site": {
"subdomain": "nasa",
"logoUrl": null,
"name": "Nasa",
"slackIntegrations": [],
"subscribers": []
},
"subscribers": []
}
]
}
}

Add an incident update

Endpoint:

POST /v1/:page_id/incidents/:incident_id/incident-updates

Example request

{
"message": "We're currently investigating an issue with the Website",
"components": ["ckf01fvnxywz50a35nh1qzssm"],
"started": "2020-09-12 05:38:47.998",
"status": "INVESTIGATING",
"notify": true,
"statuses": [
{
"id": "ckebhqpxnrk1c0a3588oztaty",
"status": "OPERATIONAL"
}
]
}

Example response

{
"id": "ckf1ew8mol30c0a32w400k6s3",
"message": "We're currently investigating an issue with the Website",
"messageHtml": "<p>We're currently investigating an issue with the Website</p>",
"status": "INVESTIGATING",
"notify": true,
"started": "2020-09-12T03:38:47.998Z",
"incident": {
"id": "ckf01m59ueaqb0a32wrljz1yd",
"name": "Rocket is going down",
"started": "2020-09-12T19:05:17.398Z",
"status": "INVESTIGATING",
"components": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"showUptime": true,
"site": {
"subdomain": "nasa",
"logoUrl": null,
"name": "Nasa",
"slackIntegrations": [],
"subscribers": []
},
"subscribers": []
}
]
}
}

Resolve an incident with a template

Endpoint:

POST /v2/:page_id/incidents/:incident_id/incident-updates/:template

Example response

{
"id": "cl8hrf2a6dsdsu4xy7vqurh",
"message": "We just resolved the issue!",
"messageTranslationId": null,
"status": "RESOLVED",
"notify": false,
"started": "2022-09-25T19:54:42.064Z",
"ended": null,
"duration": null,
"createdAt": "2022-09-25T19:54:42.126Z",
"updatedAt": "2022-09-25T19:54:42.127Z",
"incidentId": "cl8hr8gu40asdasdu4ucisqeo3",
"messageHtml": "<p>We just resolved the issue!</p>",
"messageHtmlTranslationId": null,
"importedFromStatuspage": false
}

Edit an incident update

Endpoint:

PUT /v1/:page_id/incidents/:incident_id/incident-updates/:incident_update_id

Example request

{
"message": "We're currently investigating an issue with the Website",
"components": ["ckf01fvnxywz50a35nh1qzssm"],
"started": "2020-09-12 05:38:47.998",
"status": "INVESTIGATING",
"notify": true,
"statuses": [
{
"id": "ckebhqpxnrk1c0a3588oztaty",
"status": "OPERATIONAL"
}
]
}

Example response

{
"id": "ckf1ew8mol30c0a32w400k6s3",
"message": "We're currently investigating an issue with the Website",
"messageHtml": "<p>We're currently investigating an issue with the Website</p>",
"status": "INVESTIGATING",
"notify": true,
"started": "2020-09-12T03:38:47.998Z",
"incident": {
"id": "ckf01m59ueaqb0a32wrljz1yd",
"name": "Rocket is going down",
"started": "2020-09-12T19:05:17.398Z",
"status": "INVESTIGATING",
"components": [
{
"id": "ckf01fvnxywz50a35nh1qzssm",
"name": "Website",
"status": "OPERATIONAL",
"showUptime": true,
"site": {
"subdomain": "nasa",
"logoUrl": null,
"name": "Nasa",
"slackIntegrations": [],
"subscribers": []
},
"subscribers": []
}
]
}
}

Delete an incident update

Endpoint:

DELETE /v1/:page_id/incidents/:incident_id/incident-updates/:incident_update_id

Example response

{
"id": "ckf1ew8mol30c0a32w400k6s3"
}