Setting up the webhook in Atlan¶
Create Atlan webhook¶
Now all you need to do is set up the webhook in Atlan, to call your AWS Lambda function URL.
You need to complete the other steps first
It is important you complete the other steps in this section first (setting up the AWS Lambda function). You will not be able to save the webhook in Atlan without it verifying the target for the webhook, so the AWS Lambda function must be running and able to correctly validate the test payload before setting up the webhook in Atlan.
Assuming you have completed those steps first, you should then be able to create the webhook in Atlan — for the Webhook URL enter the AWS Lambda's function URL:
Add signing secret to AWS Lambda¶
During the final step of setting up the webhook, you will be shown a Secrety Key. Copy this value for use in your AWS Lambda function to verify incoming requests are actually coming from Atlan.
Oops, I forgot to copy it. How do I get a new one?
You can find the existing signing secret again by opening your webhook, or if you need to you can generate a new one there as well. (Just remember if you generate a new one you will need to go update your AWS Lambda function to use the new one.)
To assign the key in your AWS Lambda function:
- Open the AWS Lambda functions console .
- From the list of Functions, click your AWS Lambda function.
- Change to the Configuration tab.
- From the left, click Environment variables.
- In the upper-right of the Environment variables table, click the Edit button.
- Paste the secret key from Atlan as the Value for the
SIGNING_SECRETenvironment variable. (Create one, if you did not create one earlier.)
- In the lower-right, click the Save button.
Required to process events
When using the SDKs to handle events using these steps, the signing key is required. Every request will validate the signing key before attempting any processing, so if you:
- have not set up the signing key, or
- are using the wrong signing key, or
- generated a new signing key and forgot to update this environment variable in the AWS Lambda function
Then the AWS Lambda function will reject every event it is sent.1
Except for the verification request when setting up the webhook in Atlan — that single event is unsigned. ↩