Star us on GitHub
Star
Menu

Webhooks

All alerts can route notifications to webhooks via a HTTP POST JSON payload. For example, if you are hosting an HTTP webserver listening on https://example.com/api/webhook, you can configure alerts on Highlight.

To add an outgoing webhook destination, edit an alert and set the destination URL.

Here's an example of a payload that is sent.

{ "Event": "ERROR_ALERT", "ErrorCount": 1, "ErrorTitle": "Oh no! An error occurred", "SessionURL": "https://app.highlight.io/1/sessions/", "ErrorURL": "https://app.highlight.io/1/errors/sqavrqpCyrkOdDoYjMF7iM0Md2WT/instances/11493", "UserIdentifier": "vadim@highlight.io", "VisitedURL": "https://app.highlight.io/1/alerts" }
Copy

Session alerts, user alerts, and metric monitors can all send webhook notifications. The payload resembles a similar format for all notification types.

If you are interested in customizing the payload or authenticating the webhook request with an authorization header, follow this issue on GitHub for updates.