Atlan supports the API authentication method for fetching metadata from Anomalo. This method uses an API key to fetch metadata.
Your Anomalo Deployment Admin Superuser must also configure a webhook in Anomalo to send events to Atlan when your checks run in Anomalo. This will update the check metadata in Atlan in real time.
Generate an API key
🤓 Who can do this? You must at least have an Anomalo Viewer role to generate an API key. Atlan will require read-only access to your connected data sources in Anomalo.
💪 Did you know? Atlan does not make any API requests or queries that will update the objects in your Anomalo environment.
You will need to create an API key in Anomalo for integrating with Atlan.
To create an API key for crawling Anomalo:
- Log in to your Anomalo instance.
- From the left menu of your Anomalo instance, click Settings.
- On the Settings page, in the Account tab, change to the API keys tab.
- On the API keys page, to generate a new API key:
- If you have existing API keys, click the Add an API key button.
- If you do not have any API keys, click the Create an API key button.
- In the New API Key dialog, enter the following details:
- For Description, add a meaningful description for your API key — for example,
Atlan connection
. - For Expiration, keep the default selection or select a preferred option.
- Click Save to finish creating the API key.
- For Description, add a meaningful description for your API key — for example,
- From the corresponding screen, copy the API Key value and store it in a secure location.
🚨 Careful! The API key cannot be retrieved later. You must copy the key value before closing the dialog box.
Configure a webhook
🤓 Who can do this? You will need your Anomalo Deployment Admin Superuser to complete these steps — you may not have access yourself.
As a Deployment Admin Superuser, you will need to create a webhook in your Anomalo instance to send real-time notifications to Atlan. You will need the following:
- URL of your Atlan instance
- API token generated in Atlan
To configure a webhook:
- Log in to your Anomalo instance as a Deployment Admin Superuser.
- Navigate to
/admin/main/notificationchannel/add/
to add a new webhook notification channel. - Next to Notification channels in the left menu, click + Add.
- In the Add notification channel form, configure the following:
- For Organization, select the organization for which you want to configure a webhook in Anomalo.
- Click the is default checkbox to allow the webhook to be added to all tables by default.
- From the Channel type dropdown, select Webhook.
- For Config, paste the following code in a JSON string format:
{ "to": "https://<atlan_instance>/events/anomalo", "always_send": true, "custom_headers": { "Authorization": "Bearer <API_KEY>", } }
- Replace
<atlan_instance>
with the URL of your Atlan instance. - Replace
<API_KEY>
with the API token you generated in Atlan.
- Replace
- For Description, add a meaningful description for your notification channel — for example,
Atlan webhook
. - For Deliver real time, click Yes to enable it.
- For Deliver digest, click No to disable it.
- At the bottom of the form, click Save to save your configuration.