Knowledge Base

Note: This documentation is for an old version of Outgoing Webhooks. For the latest version of webhook documentation, click here.

Outgoing webhooks run upon changes to a component's availability, notifying subscribed endpoints. A status page must have the Webhooks notifier enabled before users can add an endpoint via the Subscribe button.

Usage

A JSON payload is sent to the subscribed endpoint using the preferred HTTP verb.

Example payload:

{
  "client": {
    "name": "Example Company",
    "url": "https://status.example.com/"
  },
  "component": {
    "url": "https://status.example.com/components/574f20d2af26c94f785a4ec6",
    "name": "Redis Database",
    "group": "Platform",
    "status": {
      "state": "restored",
      "time_down": 984
    }
  },
  "meta": {
    "unsubscribe": "https://status.example.com/subscriptions/57c0baca78842843738b36fb/edit",
    "created_at": 1469656449
  }
}

component.status: This object provides the new component's state string ("degraded" or "restored"), as well as the time_down integer if restored from downtime.

Note: This version of outgoing webhooks does not send issue notifications. This is supported in v2, described here.