Skip to main content

Configure webhooks

TL;DR

Send data quality rule lifecycle and result events to external systems using webhooks.

Connect

Set up webhooks to automatically receive notifications when data quality rules are created, updated, deleted, or when rule executions pass or fail. Configure your webhook endpoint to receive these events and trigger automated responses in your incident management tools, alerting systems, or custom workflows.

Prerequisites​

Before you begin:

  • You need admin access to Atlan to create webhook
  • Prepare a webhook endpoint URL that accepts HTTPS POST requests and returns a 2xx status code
  • If your endpoint is behind a firewall or VPN, add Atlan IP addresses to your allowlist (contact support to get the IP list)

Create webhook​

Configure a webhook endpoint to receive data quality rule events. Select which events you want to monitor, validate your endpoint can receive requests, and save your webhook configuration.

  1. In your Atlan workspace, click Settings from the left menu and then click Settings.

    If you are using the Old UI (Classic), from the left menu in Atlan, click Admin.

  2. Click Webhooks.

  3. Click + New Webhook to open the webhook creation dialog.

  4. Enter a name for your webhook in the Name field.

  5. Enter your webhook endpoint URL in the Webhook URL field.

  6. Under Asset type, select Data quality rule.

  7. Under Event type, select the data quality events you want to receive:

    • Rule Created: Triggered when a new data quality rule is created
    • Rule Updated: Triggered when an existing rule is modified
    • Rule Deleted: Triggered when a rule is removed
    • Rule Passed: Triggered when a rule execution succeeds
    • Rule Failed: Triggered when a rule execution fails

  8. Click Validate to test your endpoint. Atlan sends a sample payload to verify your endpoint can receive requests. Your endpoint must return a 2xx status code for validation to succeed.

  9. After successful validation, click Save to create your webhook.

  10. From the success dialog, copy the signing secret and store it securely. Use the x-atlan-signing-secret header in incoming webhook requests to verify that requests came from Atlan before processing events.

See also​