Alerting webhooks
Datafold can send alert notifications to arbitrary endpoints of arbitrary applications with arbitrary payloads (not only JSON) when an alert violates the thresholds or an anomaly appears.
This feature is only available on request. Please contact Datafold to enable it for your organization.
Only the organization admins can configure the endpoints to which the notifications are sent. The users can use the pre-configured endpoints in alerts, but they cannot modify the URLs or payloads.
To create a webhook destination, open Admin / Settings / Integrations, click "New integration". Fill the form with the webhook URL, HTTP method, and the payload.
In the payload, you can use the following placeholders:
The id of the alert query.
The URL of the alert query.
The name of the alert query.
The status of the alert query:
  • "triggered" (the violation or anomaly was detected).
  • "error" (the query execution has failed).
{{secret1}} & {{secret2}}
The value of the secret fields in the webhook setup (hidden from the view for safety and stored encrypted). Use for API tokens, passwords, or similar things.
{{threshold_events|json}} {{threshold_events|json|str}}
A string with a JSON-serialized object describing the violated thresholds.
{{missing_data_events|json}} {{missing_data_events|json|str}}
A string with a JSON-serialized object describing the missing data.
The difference between |json and |json|str is that the former is just a JSON-serialized object, and the latter is an escaped string with the JSON-serialized object (i.e. double-serialized). The former can be used as the whole payload or in non-JSON payloads, while the latter can be put as a field value in a JSON payload. The raw non-serialized object is not provided.
Once the integration is finished, it will be available for all users to use in the alert subscriptions:
Copy link