Webhooks

Overview

Webhooks provide a way to send Metric alerts to an arbitrary URL accessible to Bigeye. Alerts are fired when a metric run ends in alerting status.

Connect a webhook to a metric

1. Navigate to a metric and click Edit.
2. Navigate to the Notifications section.
3. Enter the Webhook URL and HTTP header as needed.
4. Clicking Test will send a test payload to the endpoint.

Connect a webhook to a Collection

1. Navigate to a Collection.
2. Click on Settings.
3. Navigate to the Notifications section.
4. Enter the Webhook URL and HTTP header if needed.

Sample payload

Once set up, this is a sample payload that will be delivered to the webhook:

{
	"totalFailures":"30",
	"runTimestamp":"2021-12-17T19:31:30.081Z",
	"metricUrl":"https://app.bigeye.com/metrics/metric/0",
	"message":"Avg within 2 stddevs on `demo_subscriptions.payments.charge_amount` is alerting"
}