Webhook Notifications

Webhook Payload Examples

Incidents and scheduled maintenance events each have their own payload data.

The payload is sent via HTTP POST to the webhook URL.

Scheduled Maintenance

{
  "id":"552adb8331a9553b11000008",
  "message_id":"542adb8331a9553b11000008",
  "title":"Server Upgrades",
  "datetime":"2015-04-03T18:38:57.326Z",
  "datetime_start":"2015-04-03T18:30:00+00:00",
  "datetime_end":"2015-04-03T18:45:00+00:00",
  "current_status":"Planned Maintenance",
  "infrastructure_affected":[
    {"component":"551ed627b556f14210000005", "container":"551ed5ac590f5a3b10000006"},
    {"component":"551ed627b556f14210000005", "container":"551ed5b1c9f9404110000005"}
  ],
  "components":[
    {"name":"Chat Service",
    "_id":"551ed627b556f14210000005"}
  ],
  "containers":[
    {"name":"US East",
    "_id":"551ed5ac590f5a3b10000006"},
    {"name":"US West",
    "_id":"551ed5b1c9f9404110000005"}
  ],
  "details":"We've completed upgrades for all US East servers. No issues so far. Moving on to US West next. Updates to follow.",
  "maintenance_url":"https://status.io/pages/maintenance/5516e01e2e55e4e917000005/5116e01e2e33e4e413000001",
  "status_page_url":"https://status.io/pages/5516e01e2e55e4e917000005"
}

Incident

{
  "id":"551edb8331a9664b11000005",
  "message_id":"531adb8331a9553b11000008",
  "title":"Database Issues",
  "datetime":"2015-04-03T18:27:15.344Z",
  "datetime_start":"2015-04-03T18:27:15+00:00",
  "datetime_resolve":"",
  "current_status":"Degraded Performance",
  "current_state":"Identified",
  "previous_status":"",
  "previous_state":"",
  "infrastructure_affected":[
    {"component":"551ed627b556f14210000005", "container":"5516e01e2e55e4e917000014"},
    {"component":"551ed627b556f14210000005", "container":"551ed5d3590f5a3b10000008"},
    {"component":"551ed5f5590f5a3b10000009", "container":"551ed5d3590f5a3b10000008"},
    {"component":"5516e01e2e55e4e917000015", "container":"5516e01e2e55e4e917000014"},
    {"component":"5516e01e2e55e4e917000015", "container":"551ed5d3590f5a3b10000008"}
  ],
  "components":[
    {"name":"Chat Service",
    "_id":"551ed627b556f14210000005"},
    {"name":"Voice Services",
    "_id":"551ed5f5590f5a3b10000009"},
    {"name":"Admin Dashboard",
    "_id":"5516e01e2e55e4e917000015"}
  ],
  "containers":[
    {"name":"Ireland",
    "_id":"5516e01e2e55e4e917000014"},
    {"name":"London",
    "_id":"551ed5d3590f5a3b10000008"}
  ],
  "details":"A database instance has become unhealthy and removed from the cluster. Europe based endpoints will continue experiencing higher than normal latency until a new instance is fired up. Updates to follow.",
  "incident_url":"https://status.io/pages/incident/5516e01e2e55e4e917000005/5116e01e2e33e4e413000001",
  "status_page_url":"https://status.io/pages/5516e01e2e55e4e917000005"
}

We also store the payload examples on GitHub: https://github.com/statusio/notifications-webhook