Creating a custom webhook alert receiver

Use the Data Observability custom webhook alert receiver to send your alerts to an endpoint that accepts POST requests and doesn't require authentication. You can use it for cases where your preferred receiver type is not available as a built-in option.

Required permissions

For more details about permissions, see Required permissions.

Procedure

To set up a custom webhook alert receiver:

  1. In the Data Observability page of the watsonx.data integration UI, click New alert receiver, then choose Custom webhook as the alert receiver type.

  2. Provide a unique name for the alert receiver.

  3. Enter the URL of the endpoint where you want to send alerts.

  4. To confirm that the alert receiver is working properly, click Create receiver. Check the custom webhook for the notification. If you receive it, click Verify. The alert receiver is configured properly.

  5. Optional: Select the alerts to which you want to assign the alert receiver.

  6. Click Create.

Alert parameters

When you create a custom webhook receiver, Data Observability sends the alert payload in the form of a single JSON object. As a result, you can't provide custom mapping from Data Observability alert fields to fields in the receiving system. The JSON object might include the following parameters:

List of parameters, their type, and their description
Field Type Description
data_observability_link string The URL of the Triggered alerts page in Data Observability.
id integer A unique ID for the alert.
name string The name of the alert as defined in Data Observability.
severity string The alert severity as defined in Data Observability (Critical, High, Medium, or Low).
status string The alert state in Data Observability (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.
type string The alert type.
workspace string The workspace that the alerted asset belongs to.
job string The job from which the alert originated.
run string The timestamp of the run for which the alert was triggered.
metric string The metric name for which the alert is defined.