Skip to main content
All CollectionsIntegrations
Data Push Destinations - Incident Schema
Data Push Destinations - Incident Schema
Updated over a week ago

Incident Data

Incident data is available if you are using the Incident Detection feature. Using the Incident data, you will receive a message when an Incident is detected (ONGOING) and another when the incident ends (RESOLVED).

To see the issues included in the incident, you also need to set up a second data push using the issue schema. The event_type field has been added to the issue schema which can tell you when issues have been added to an incident (INCIDENT_ADDED) or removed from an incident (INCIDENT_REMOVED). In addition, the incident_uid has been added to the issue schema so you can track which incident the issue is part of.

Incident Schema

Name

Type

Comments

name

string

The Incident name. For example 'Incident AUG/2022-053'

context

object

Object containing context of the incident

customer_uid

string

Customer UID

status

string

Status of the incident. Will be "ONGOING" or "RESOLVED"

started_at

datetime

timestamp incident started
YYYY-MM-DDThh:mm:ss

(UTC time)

ended_at

datetime

timestamp incident ended
YYYY-MM-DDThh:mm:ss

(UTC time)

timestamp

datetime

timestamp of the message
YYYY-MM-DDThh:mm:ss

(UTC time)

uid

string

Unique uid of the incident.

Here is a sample of the Incident format:

{
"uid":"b8c2224a-63b3-4235-ac78-f4c1cf412444",
"name":"Incident AUG/2022-053",
"status":"RESOLVED",
"timestamp":"2022-08-10T20:56:27",
"started_at":"2022-08-09T01:35:23",
"ended_at":"2022-08-10T20:33:27",
"context":{
"customer_uid":"7ae10733-a344-4f6c-8bc7-447ce3d76388"
}
}
Did this answer your question?