id |
String |
The ID of the incident. |
type |
String |
incident |
attributes |
Object |
Attributes object. See below. |
attributes.name |
String |
Name of the incident. |
attributes.url |
String |
URL of the incident. |
attributes.http_method |
String |
Which HTTP method was used. |
attributes.cause |
String |
What caused the incident. |
attributes.incident_group_id |
Integer |
ID of the incident group. Can be null . |
attributes.started_at |
String (ISO DateTime format) |
When the incident started. |
attributes.acknowledged_at |
String (ISO DateTime format) |
When was the incident acknowledged. |
attributes.acknowledged_by |
String |
Who acknowledged the incident. |
attributes.resolved_at |
String (ISO DateTime format) |
When was the incident resolved. |
attributes.resolved_by |
String |
Who resolved the incident. |
attributes.status |
String |
Current status of the incident. Valid values: Unconfirmed , Started , Acknowledged , Resolved , Validating . |
attributes.team_name |
String |
The team this incident is in. |
attributes.response_content |
String |
Content of the response that triggered the incident. |
attributes.response_options |
JSON string |
Response metadata of the response performed by the monitor. |
attributes.regions |
Array of strings |
Region of the performed check. Valid values: us eu as au . |
attributes.response_url |
String |
Link to the text/source code snapshot of your site during the incident - similar to screenshot_url , but not rendered. |
attributes.screenshot_url |
String |
URL of the screenshot taken at the time of the incident. |
attributes.origin_url |
String |
URL of the integration that caused the incident. |
attributes.escalation_policy_id |
String |
ID of the escalation policy that is in place. |
attributes.ssl_certificate_expires_at |
String (ISO DateTime format) |
Time at which the SSL certificate will expire (only present if the incident is about a certificate expiration) |
attributes.domain_expires_at |
String (ISO DateTime format) |
Time at which the domain will expire (only present if the incident is about a domain expiration) |
attributes.call |
Boolean |
Call the on-call person. |
attributes.sms |
Boolean |
Send an SMS to the on-call person. |
attributes.email |
Boolean |
Send an email to the on-call person. |
attributes.push |
Boolean |
Send a push notification to the on-call person. |
attributes.metadata |
Object |
Metadata key-value pairs. |
attributes.metadata.* |
String |
Metadata value for given key. |
relationships |
Object |
Relationships object. See below. |
relationships.monitor |
Object |
Monitor object. See below. |
relationships.monitor.data |
Object |
Monitor Data object contains information about the monitor which triggered the incident. |
relationships.monitor.data.id |
String |
ID of the monitor which triggered the incident. |
relationships.monitor.type |
String |
monitor |
relationships.heartbeat |
Object |
Heartbeat object. See below. |
relationships.heartbeat.data |
Object |
Heartbeat Data object contains information about the heartbeat which triggered the incident. |
relationships.heartbeat.data.id |
String |
ID of the heartbeat which triggered the incident. |
relationships.heartbeat.type |
String |
heartbeat |
relationships.webhook_integration |
Object |
Webhook integration object. See below. |
relationships.webhook_integration.data |
Object |
Webhook integration Data object contains information about the integration which triggered the incident, also present for incidents triggered by Dashboard alert. |
relationships.webhook_integration.data.id |
String |
ID of the webhook integration which triggered the incident. |
relationships.webhook_integration.type |
String |
webhook_integration |