For the complete documentation index, see llms.txt. This page is also available as Markdown.

Webhook

Send Data Quality alerts to your own endpoint, with the payload Decube posts.

A webhook action posts each matching incident to an endpoint you control, so you can route alerts into an incident management tool, a ticketing system, or your own service.

What your endpoint needs

  • An https:// URL reachable from the public internet.

  • A quick 2xx response. Do your processing after you respond rather than while Decube waits.

  • Tolerance for new fields. Decube may add fields to the payload over time, so parse what you need and ignore the rest.

Add a webhook to a rule

  1. In Set up alert channels, select Webhook on a channel row.

  2. Enter the endpoint in Webhook URL.

  3. Add an HTTP header if your endpoint expects one, for example Authorization with a value of Bearer <your token>. Use Add for additional headers.

  4. Click Test alert and confirm your endpoint received the request.

Headers are the place for credentials. Keeping a token in the URL means it appears in your endpoint's logs.

The payload

Decube posts JSON. asset is the primary asset the monitor watches, attribution_assets carries the other assets involved where a monitor spans more than one, and evidence describes what the run measured and why it failed.

The shape of evidence depends on the monitor type, since a Freshness failure and a Null failure describe themselves differently.

Frequently Asked Questions

How do I tell which rule sent a request?

Add a header that identifies the rule when you configure the action, for example X-Decube-Rule with the rule name. Decube sends the headers you configure with every delivery from that action.

Last updated