Webhook Version 2.0
Our Webhook Integration has evolved over time to meet the needs of advanced users. Webhook Version 2.0, released in April 2020, is documented below. However, this version is no longer available for new users. It has been deprecated and is superseded by Version 3.0.
Below is a fictitious event for the Heroku application hosting service. This JSON message is typical of a webhook notification which might be posted to a configured webhook URL. Upon receipt, the webhook URL endpoint should return a "200" HTTP status code.
{
"component_status_changes" : [
{
"group_name": null,
"name": "Apps",
"last_status": "up",
"current_status": "warn"
}
],
"component_statuses" : [
{
"group_name" : null,
"name" : "Apps",
"status" : "warn"
},
{
"group_name" : null,
"name" : "Data",
"status" : "up"
},
{
"group_name" : null,
"name" : "Tools",
"status" : "up"
}
],
"current_status" : "warn",
"details" : "Some users are experiencing deployment delays",
"favicon_url" : "https://favicons.statusgator.com/heroku.ico",
"home_page_url" : "https://www.heroku.com",
"last_status" : "up",
"message" : "Application deployment performance",
"occurred_at" : "2022-01-20T10:52:30-04:00",
"service_name" : "Heroku",
"slug" : "heroku",
"status_page_url" : "https://status.heroku.com"
}A few things to note about the message above:
- The
component_statusesandcomponent_status_changessections can be empty. If a status page has no components or there are no component status changes, these entries will be an empty list. - Not all status pages with components will organize components into groups. In this case, the value for the group_name attribute will be "null".
- Messages and details can also be empty in some cases:
- When the provider doesn't publish incident messages at all or did not publish an incident message at the time.
- If our integration with the providers status page or API does not support incident messages. If you see a status page that does display messages but we are missing them, please reach out to us and we can investigate.