Webhooks
Creating a webhook
On the navigation bar, go to Connect > Webhooks > Configure Webhooks > Create New Webhook.
In New Webhook, enter the following details:
Name — A name to identify the webhook in DXA.
Destination URL — The alert destination URL.
To select one or more Alerts to Link to the destination:
Click +.
A list of your saved alerts appears.
In the list, select one or more alerts.
Select one of the following authentication methods for the destination:
None — The destination doesn't require authentication.
Basic — The destination requires a username and password.
- If you selected Basic authentication, enter the Username and Password required to log in to the destination.Note: DXA recommends using credentials for an account that is not linked to a specific user, such as an account created only to manage the DXA webhook. If the credentials are linked to a specific user, you may not be able to log in to the account to manage the webhook if that user leaves the company.
To test that the webhook can connect to the destination using the Destination URL entered above, click Test Connection.
Click Save.
The webhook is saved and appears on the top of the Webhooks table. The selected alert(s) will now be sent to the target destination when triggered.
Viewing, editing, and deleting a webhook
On the Webhooks table, click the webhook you want to view, edit, or delete.
Tab | Description |
---|---|
Settings | Lists all details applied to the webhook when it was created or edited. |
Activities | Lists all instances that the alert was triggered through the webhook. To view the server error message for a failed alert, click Server Response Details. |
To edit the webhook using the same configurations available when creating a webhook, click Edit.