Integrations
Webhook

Webhook

Webhooks are a way to send notifications to your own application or service.

Setup

  1. Go to the Spectate Incident Channels (opens in a new tab) and select "Webhook".
  2. Enter the webhook URL, optionally custom headers, and click "Save".
  3. You can now send a test notification to make sure everything is working.

The test notification has the following payload:

{
  "title":"Test notification for Realify",
  "message":"200 OK - Test notification sent successfully"
}

Payload

The payload is a JSON object with the following properties:

PropertyDescription
checkThe type of check that was performed.
Possible values: uptime, certificate
statusThe status of the check.
Possible values: recovered, down
incidentThe incident that was created.
incident.idThe ID of the incident.
incident.started_atThe date and time the incident was created.
incident.resolved_atThe date and time the incident was resolved. Only provided in recovered notifications.
incident.reasonThe reason the incident was created.
incident.severityThe severity of the incident.
Possible values: critical, high, medium, low, none
monitorThe monitor that was checked.
monitor.idThe ID of the monitor.
monitor.labelThe label of the monitor.
monitor.urlThe URL of the monitor.
heartbeatsArray containing the heartbeats leading to the notification.
heartbeats.idThe ID of the heartbeat.
heartbeats.protocolThe protocol of the heartbeat.
Possible values: http, https, icmp
heartbeats.locationThe location of the heartbeat.
Possible values: ams, blr, fns, lon, nyc, sfo, sgp, syd
heartbeats.http_urlThe URL of the heartbeat.
heartbeats.response_timeThe response time of the heartbeat.
heartbeats.status_codeThe status code of the heartbeat.
heartbeats.packet_lossThe packet loss of the heartbeat.
heartbeats.aliveWhether the heartbeat is alive.
Possible values: true, false

Custom Headers

You can optionally add custom headers to the webhook request. This can be useful if you need to authenticate with your webhook service.