Skip to main content

Configure webhooks

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. From the left menu in Atlan, click Admin, then under Workspace, click Webhooks.

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

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

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

  5. Under Asset type, select Data quality rule.

  6. 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
  7. 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.

    Did you know?

    Atlan sends a JSON payload that includes an eventType field and a ruleData object. The payload contains details about the rule, the asset it was applied to, and the execution result.

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

  9. 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

  • Create webhooks: Create and validate a webhook endpoint in Atlan
  • Configure alerts: Configure Slack or Microsoft Teams notifications for data quality rule failures