Custom webhook receivers

You can use the Databand custom webhook receiver to send your alerts to nearly any endpoint that accepts POST requests for cases where your preferred receiver type is not natively supported.

Adding a custom webhook receiver

To add a custom webhook receiver:

  1. Go to Alerts > Receivers > Add receiver, and select Custom.
  2. Provide the following details:
    Receiver name
    The name of the receiver to be displayed in the Databand UI.
    URL
    The endpoint to which you want to send alerts.
  3. Click Test connection to validate the URL that you provided.
  4. Click Next.
  5. Choose the defined alerts that you want to be notified about through this receiver, then click Save.

Alert parameters

When you create a custom webhook receiver, Databand sends alerts in JSON that include the following parameters, if the parameters apply to your alert:

Table 1. List of parameters, their type, and their description
Field Type Description
databand_link string The URL of the Alert details page in Databand
id integer A unique ID for the alert
name string The name of the alert as defined in Databand
severity string The alert severity as defined in Databand (Critical, High, Medium, or Low)
status string The alert state in Databand (Triggered, Acknowledged, or Resolved)
trigger_value string The value that caused the alert to be triggered
triggered_on datetime The time when the alert was originally triggered
acknowledged_on datetime The time when the alert was acknowledged
resolved_on datetime The time when the alert was marked resolved
updated_on datetime The time of the alert's most recent status update. If no updates were made, this value is the time that the alert was triggered.
type string The alert type
source string The data source integration that the alerted asset belongs to.
project string The project that the alerted asset belongs to.
pipeline string The pipeline from which the alert originated.
run string The run name from which the alert originated.
task string The task name from which the alert originated.
metric string The metric name for which the alert is defined.
datasets array of strings The datasets that are associated with the alert.
columns array of strings The column names that are associated with the alert.

Known issues

  • You can create custom webhook receivers only with endpoints that do not require authentication.
  • The alert payload is sent in the form of a single JSON object. You can't provide custom mapping from the Databand alert fields to fields in the receiving system.