Custom Webhook Receivers
Overview
Databand's custom webhook receivers can be used to send your alerts to nearly any endpoint that accepts POST requests. This provides extra flexibility for alert routing in cases where your preferred receiver type is not natively supported.
Setup
- Go to Alerts -> Receivers, click Add Receiver, and select Custom.
- Provide the following details:
- Receiver name - The name of the receiver that will be displayed in the Databand UI.
- URL - The endpoint to which you want to send alerts.
- (Optional) Click Test Connection to validate the URL provided.
- Click Next.
- Select the alert definitions that should be paired with your new receiver, then click Save.
Alert Schema
When using custom webhook receivers, Databand will send alerts in JSON format using the schema below:
| Field | Type | Description |
|---|---|---|
databand_link |
string | URL to the alert details page in Databand |
id |
integer | unique ID for the alert |
name |
string | name of the alert as defined in Databand |
severity |
string | alert severity as defined in Databand (Critical, High, Medium, or Low) |
status |
string | alert state in Databand (Triggered, Acknowledged, or Resolved) |
trigger_value |
string | value that caused the alert to be triggered |
triggered_on |
datetime | time that the alert was originally triggered |
acknowledged_on |
datetime | time that the alert was acknowledged |
resolved_on |
datetime | time that the alert was resolved |
updated_on |
datetime | time of the alert's most recent status update, defaults to the time that the alert was triggered if no updates have been made yet |
type |
string | alert type |
source |
string | data source integration that the alerted asset belongs to (where applicable) |
project |
string | project that the alerted asset belongs to (where applicable) |
pipeline |
string | pipeline from which the alert originated (where applicable) |
run |
string | run name from which the alert originated (where applicable) |
task |
string | task name from which the alert originated (where applicable) |
metric |
string | metric name for which the alert is defined (where applicable) |
datasets |
array of strings | data sets associated with the alert (where applicable) |
columns |
array of strings | column names associated with the alert (where applicable) |
Known Limitations
- Only endpoints that do not require authentication are supported.
- The alert payload that is sent is in the form of a single JSON object. There is currently no option to provide a custom mapping for the Databand alert fields to fields in the receiving system.