Integrating StatusGator with Webhooks
Background
A webhook is a HTTP endpoint where notifications are delivered. Status changes are posted to a configured webhook URL. Webhooks provide a convenient method of integrating StatusGator with other systems. Webhook notifications are sent based on the notification level set in the service subscription. One webhook can be configured per dashboard.
Configuring
Webhooks can be configured by clicking the Integrations link in the header of a dashboard. When viewing the integrations page find the webhooks integration section. Activate webhook notifications using the toggle switch. A valid HTTP or HTTPS URL will be required to save and activate the integration.
Webhook Format
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".
Failures and Retries
If StatusGator is unable to receive a 200 response from your webhook URL five times, your webhook integration will be disabled. To fix the webhook URL visit your dashboard and click the Integrations button in the header and fix any issues with your URL to re-activate the webhook.
Non-connection-related failures will be retried 20 times over a period of 24 days. StatusGator waits a period of time between retries. This delay increases starting a few seconds growing to over a day before the exhausting all retries. When retries are exhausted, the webhook is discarded.