Email channel
Create an email alert channel by passingtype: "EMAIL" and a config object with the recipient address.
Config fields
The recipient email address. Overwatch sends one email per status-change event for each monitor bound to this channel.
Email delivery relies on Overwatch’s sending infrastructure. If you do not receive an alert, check your spam folder and make sure
alerts@mail.overwatchapp.dev is allowed by your mail filters.Webhook channel
Create a webhook alert channel by passingtype: "WEBHOOK" and a config object with your endpoint URL. You can also include an optional HMAC secret so you can verify that requests genuinely come from Overwatch.
Config fields
The HTTPS endpoint that Overwatch sends a
POST request to when a monitor changes state. Must be publicly reachable.An optional HMAC secret. When set, Overwatch signs each outgoing request so you can verify authenticity on your server. See Verifying webhook requests below.
Webhook payload
When a monitor changes state, Overwatch sends aPOST request with a Content-Type: application/json body. The payload includes the details of the status-change event:
- Monitor identifiers — the monitor’s
idandname. - Monitor type — the check type, such as
HTTP,TCP,TLS,DNS, orSCHEDULED. - Status transition — the previous status and the new status (e.g.
up→down). - Timestamp — when the status change occurred.
Verifying webhook requests
When you set asecret in the config, Overwatch includes a signature header with each request. On your server, compute an HMAC of the raw request body using the same secret and compare it to the header value. Reject any request where the signatures do not match.
Updating a channel’s config
UsePATCH /api/v1/alerts/:id to update an existing channel’s name, config, or enabled state. You can pass any combination of fields — only the fields you include are changed.
When you update
config, pass the full config object. Overwatch replaces the stored config entirely rather than merging individual keys.Deleting a channel
200 with the ID of the deleted channel: