Webhooks

Setup

The test notification has the following payload:

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

The payload is a JSON object with the following properties:

Property	Description
`check`	The type of check that was performed. Possible values: `uptime`, `certificate`
`status`	The status of the check. Possible values: `recovered`, `down`
`incident`	The incident that was created.
`incident.id`	The ID of the incident.
`incident.started_at`	The date and time the incident was created.
`incident.resolved_at`	The date and time the incident was resolved. Only provided in recovered notifications.
`incident.reason`	The reason the incident was created.
`incident.severity`	The severity of the incident. Possible values: `critical`, `high`, `medium`, `low`, `none`
`monitor`	The monitor that was checked.
`monitor.id`	The ID of the monitor.
`monitor.label`	The label of the monitor.
`monitor.url`	The URL of the monitor.
`heartbeats`	Array containing the heartbeats leading to the notification.
`heartbeats.id`	The ID of the heartbeat.
`heartbeats.protocol`	The protocol of the heartbeat. Possible values: `http`, `https`, `icmp`
`heartbeats.location`	The location of the heartbeat. Possible values: `ams`, `blr`, `fns`, `lon`, `nyc`, `sfo`, `sgp`, `syd`
`heartbeats.http_url`	The URL of the heartbeat.
`heartbeats.response_time`	The response time of the heartbeat.
`heartbeats.status_code`	The status code of the heartbeat.
`heartbeats.packet_loss`	The packet loss of the heartbeat.
`heartbeats.alive`	Whether the heartbeat is alive. Possible values: `true`, `false`

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