Auth0 Extension: Auth0 Management API Webhooks
The Auth0 Management API Webhooks Extension allows you to use your own custom webhooks in conjunction with the Auth0 Management API. The extension will go through the audit logs and call the appropriate webhook if specific event(s) occur.
Configuring the Extension
To complete installation of this extension, click on the Auth0 Management API Webhooks box in the list of provided extensions on the Extensions page of the Management Portal. In the "Install Extension" window that then pops open, you will be asked to provide the following configuration variables:
- Schedule: The frequency with which the job runs
- Batch_Size: The amount of logs the extension will attempt to read and send on each execution. Extension could send multiple batches per run, depending on amount of time necessary to process.
- Auth0_API_Endpoints: The specific Auth0 Management API endpoints you want to monitor/call
- Webhook_URL: The URL of your webhook
- Authorization: String to be added as
- Send_as_Batch: If enabled, the extension will send the whole batch of logs to the webhook in a single request. Otherwise, extension sends logs one-by-one to webhook. Only disable if your webhook does not support batched messages.
- Webhook_Concurrent_Calls: The maximum number of concurrent calls that will be made to your webhook.
- Start_From: Log Checkpoint to start from.
- Slack_Incoming_Webhook_URL: Extension can report statistics and possible failures to the Slack.
- Slack_Send_Success: If enabled, extension will be sending messages on each run. Otherwise - only on fails.
Once you have provided the required pieces of information, click "Install" to finish installing the extension.
Using Your Installed Extension
You can view all scheduled jobs by clicking on the Auth0 Management API Webhooks line under the "Installed Extensions" tab.
Here is an example of the payload that will be sent:
How to Troubleshoot Webhooks
If your webhook isn't working, it can be difficult to troubleshoot and determine what is causing the issue. Webhooks are asynchronous, so testing them can involve you triggering the webhook, waiting, and then checking the response (assuming that you did receive a response).
However, there are certainly alternatives to the inefficient process we detailed above. While full details of how to troubleshoot a particular webhook is outside the scope of this article, here are some steps you can take to debug:
Mock requests using cURL or Postman