Webhooks format

Here are the format of webhooks you will get if you subscribed via webhooks"

When an incident is added or updated:

{
"meta": {
"unsubscribe": "",
"documentation": "",
},
"page": {
"id": "",
"status_indicator": "",
"status_description": "",
"url": ""
},
"incident": {
"backfilled": false,
"created_at": "",
"impact": "",
"name": "",
"resolved_at": "",
"status": "",
"updated_at": "",
"id": "",
"url": "",
"incident_updates": [{
"id": "",
"incident_id": "",
"body": "",
"status": "",
"created_at": "",
"updated_at": "",
}],
},
}

When a maintenance is added or updated:

{
"meta": {
"unsubscribe": "",
"documentation": "",
},
"page": {
"id": "",
"status_indicator": "",
"status_description": "",
"url": ""
},
"maintenance": {
"backfilled": false,
"created_at": "",
"impact": "",
"name": "",
"resolved_at": "",
"status": "",
"updated_at": "",
"id": "",
"url": ""
"duration": "",
"maintenance_updates": [{
"id": "",
"maintenance_id": "",
"body": "",
"status": "",
"created_at": "",
"updated_at": "",
}],
},
}

When a component is added or updated:

{
"meta": {
"unsubscribe": "https://dashboard.instatus.com/unsubscribe?id=${subscriber.id}&token=${subscriber.unsubscribeToken}",
"documentation": "",
},
"page": {
"id": "",
"status_indicator": "",
"status_description": "",
"url": ""
},
"component_update": {
"created_at": "",
"new_status": "",
"component_id": "",
},
"component": {
"created_at": "",
"id": "",
"name": "",
"status": "",
},
}

Possible status page statuses:

  • UP
  • HASISSUES
  • UNDERMAINTENANCE

Possible component statuses:

  • OPERATIONAL
  • UNDERMAINTENANCE
  • DEGRADEDPERFORMANCE
  • PARTIALOUTAGE
  • MAJOROUTAGE

Possible incident statuses:

  • INVESTIGATING
  • IDENTIFIED
  • MONITORING
  • RESOLVED

Possible maintenance statuses:

  • NOTSTARTEDYET
  • INPROGRESS
  • COMPLETED