How to create webhooks

πŸ€“ Who can do this? You will need to be an admin user in Atlan to create webhooks.

Webhooks allow you to monitor events happening in Atlan, receive notifications for these events to a URL of your choice, and take action right away. For example, you can create a webhook to send notifications to your email address or messaging app when a term is updated or an asset is tagged.

Webhooks send the payload in a specific format that cannot be customized. This is meant for consumption by a programmatic entity down the line β€” for example, AWS Lambda or a microservice. For a webhook to be consumed directly, Atlan will need to customize the payload, which is currently not supported. Alternatively, you can explore out-of-the-box integrations such as Slack and Microsoft Teams.

Atlan currently supports creating webhooks for the following event types:

  • Asset creation, deletion, and metadata update
  • Custom metadata update for assets
  • Tag attachment or removal from assets

Create a webhook

To create a webhook:

  1. From the left menu in Atlan, click Admin.
  2. Under Workspace, click Webhooks.
  3. On the Webhooks page, click + New Webhook to create a new webhook.
  4. In the New Webhook dialog, enter the following details:
    1. For Name, enter a meaningful name for your webhook.
    2. For Webhook URL, enter the URL for where you want to receive event notifications.
    3. For Asset type, select the asset types for which you'd like to receive notifications. (This will default to all asset types, if none are specified.)
    4. For Event type, under Assets, select all the event types for which you'd like to receive notifications:
    5. To validate the URL you've entered, in the upper right, click the Validate button.
      🚨 Careful! Atlan will send a sample payload to test if the webhook URL is correct. You will need to respond with a 2xx status for the validation to succeed. Atlan will also run this validation before you save your webhook as a precautionary measure.
    6. Click Save to finish creating your webhook.
    7. From the Webhook successfully created dialog, under Secret Key, click the clipboard icon to copy the secret key and store it in a secure location to verify requests from Atlan.
    8. Click Done to complete setup.

Verify requests from Atlan

Atlan signs its webhooks using a secret that is unique to your app. With the help of signing secrets, you can verify the authenticity of such requests with confidence.

Each HTTP request sent from Atlan will include an x-atlan-signing-secret HTTP header. You can use the secret key for your webhook to validate requests from Atlan.

Related articles

Was this article helpful?
0 out of 0 found this helpful