The functionality in this article is set to be released in an upcoming update.
This article explains how to manage Webhooks and monitor their delivery from the Webhooks page in Client Settings. From this page, you can add, edit, and delete Webhooks, review the delivery history for every Event Absorb sends, view details for failed deliveries, and retry a failed delivery with one click.
This visibility helps you confirm that deliveries to your listener URL are succeeding and resolve failures without contacting Absorb Support.
For general information about how Webhooks work, including available Events, payload contents, and Secret Key verification, see the Webhooks article.
Access the Webhooks Page
The Webhooks page is available to System Admins, the same permission required to access other options on the Client Settings page. This feature is entirely Admin facing, and Learners have no visibility into it.
For more information about the Client Settings page, see The Client Settings Page.
To open the Webhooks page:
- Log in to the LMS using your Administrator account.
- Click your Account icon in the top-right corner of the page.
- In the right-hand pane, scroll down and click Client Settings.
- Click the Webhooks tile.
The Webhooks page is enabled for each Portal individually. If the Webhooks tile does not appear on your Client Settings page, reach out to your Client Success representative.
Key Terms
The following terms appear throughout the Webhooks page and this article:
Term |
Description |
| Delivery | A single attempt, either the original dispatch or a Manual Retry, to send one Event to one Webhook. |
| Dispatched | The time Absorb originally sent the Event to the Webhook's listener URL. This value always shows the original send time, even after retries. |
| Automatic Retry | One of two immediate retries Absorb performs when a delivery fails, before the delivery is shown as Failed. Automatic retries are not displayed or counted on the Webhooks page. |
| Manual Retry | A retry that an Admin triggers from the Webhooks page. The Retries column counts manual retries only, up to a maximum of five per delivery. |
| Payload | The JavaScript Object Notation (JSON) body Absorb attempted to send to the listener URL. The payload is retained for failed deliveries only and appears in the Event details window. |
Manage Webhooks
The Webhooks tab lists each Webhook configured for your Portal, including its Name, URL, subscribed Events, and Status. This page replaces the previous window-based management experience, so you can add, edit, delete, and open individual Webhooks from one location.
If no Webhooks are configured yet, the page displays an empty state with an Add new webhook button.
Add a Webhook
New Webhooks are created from the New webhook window. For detailed guidance on each field, see the Webhooks article.
- Click Add new webhook.
- Confirm that the Enable webhook toggle is turned on.
- Enter a Name for the Webhook.
- Enter your listener URL.
- Select one or more Events from the Events dropdown.
- Optionally, click Test webhook to confirm that your listener URL is ready to receive Events.
- Click Save.
The Secret key field populates after you save the Webhook. You can use this key to verify the signature of incoming Webhook requests.
Edit or Delete a Webhook
Each row on the Webhooks tab includes actions for maintaining that Webhook. In the Actions column, click the edit icon to update the Webhook's configuration, or click the delete icon to remove it.
To pause a Webhook without deleting it, edit the Webhook and turn off the Enable webhook toggle.
View an Individual Webhook
Each Webhook has its own page that combines its configuration with a delivery history scoped to that Webhook only. This view is useful for troubleshooting a single integration without reviewing deliveries for every other Webhook in your Portal.
To open a Webhook's page, click its row on the Webhooks tab.
The breadcrumb displays Client Settings > Webhooks > Webhook name, and the page includes:
- A configuration card showing the Webhook's URL, subscribed Events, masked Secret key, and created date.
- A delivery history for that Webhook only, where you can review deliveries and retry failed deliveries directly from the page.
To copy the Webhook's URL or Secret key, click the copy option on the configuration card. A confirmation message appears after each copy.
Monitor Webhook Deliveries
The Events tab displays the delivery history for all Webhooks in your Portal, so you can confirm whether Events are reaching your listener URLs and quickly identify failures. To open it, click the Events tab on the Webhooks page.
Each row in the Delivery history table represents one delivery. You can retry failed deliveries directly from this table.
Set the Date Range
The delivery history shows the Last 24 hours by default. To view a different period, open the date range selector at the top right of the page, then choose a quick range for the last three days, the current month, or the previous month, or set a custom range. When setting a custom range, the end date must be on or after the start date.
Filter Delivery History
Click Filters to narrow the delivery history by any of the following criteria:
- Event name
- Delivery status, either Delivered or Failed
- Response status code
Summary Tiles
Three summary tiles at the top of the page show the Total, Delivered, and Failed delivery counts for the selected date range. The tiles reflect the date range only and do not change when you apply filters to the table.
Delivery History Columns
The following columns help you interpret each delivery in the Delivery history table:
Element |
Description |
| Status | Whether the delivery was Delivered or Failed. |
| Event | The name of the Event that triggered the delivery. |
| Status code | The response status code returned by your listener URL. A failed delivery can have no status code if the listener URL could not be reached. |
| Dispatched | The time the Event was originally sent. This value does not change after a retry. |
| Duration | Reflects the most recent attempt. For a retried delivery, this value is measured from the latest Manual Retry rather than the original dispatch. |
| Retries | The number of Manual Retries performed on the delivery, up to a maximum of five. |
| Actions | Contains the Retry icon for failed deliveries. |
Review and Retry Failed Deliveries
When a delivery fails, Absorb retains its payload and error message so you can investigate the cause and resend the Event once the issue is resolved. Payload and error details are stored for failed deliveries only, so rows for successful deliveries cannot be opened.
View Event Details
The Event details window shows the full context of a failed delivery. To open it, click a failed delivery row on the Events tab or on an individual Webhook's page.
The Event details window displays the following information:
- The Event type, delivery status, and response status code.
- The Webhook the delivery was sent to and the Dispatched time.
- An error message describing why the delivery failed.
- The Payload Absorb attempted to send.
Retry a Failed Delivery
After you resolve the issue with your listener URL, you can resend a failed delivery. Retries are performed one delivery at a time.
- Locate the failed delivery on the Events tab or on the Webhook's page.
- Click the Retry icon in the Actions column, or click Retry in the Event details window.
A confirmation appears immediately to indicate that the retry was accepted. The delivery's updated outcome appears the next time the delivery history refreshes.
Each delivery can be retried manually up to five times. After the fifth Manual Retry, Retry is disabled for that delivery.
Before a delivery is shown as Failed, Absorb automatically retries it twice. These Automatic Retries are not displayed or counted, so a newly failed delivery always shows 0 in the Retries column. The Retries count includes Manual Retries only.
Troubleshooting Delivery Behavior
Some delivery details can look unexpected at first but work as designed. The following sections explain these behaviors and how to resolve common issues with retries and date ranges.
Retries Count Shows 0 on a Failed Delivery
The Retries column counts Manual Retries only. Every failed delivery has already gone through two Automatic Retries before it is shown as Failed, and those are not counted. A newly failed delivery always starts at 0.
Dispatched and Duration Look Inconsistent on a Retried Delivery
Dispatched always shows the original send time, while Duration reflects the most recent retry attempt. For example, a delivery originally sent on Monday and retried on Friday shows Monday as the Dispatched time, while its Duration reflects the Friday retry.
A Successful Delivery Cannot Be Opened
Rows for successful deliveries are not clickable, and no Event details window is available for them. Payload and error details are stored for failed deliveries only, so there is no additional information to display.
Summary Tiles Do Not Match the Filtered Table
The Total, Delivered, and Failed tiles reflect the selected date range only. Filtering the table by event name, status, or status code does not update the tiles.
Retry Is Disabled
Retry is disabled when a delivery has reached the limit of five Manual Retries. No further retries are available from the Webhooks page for that delivery. Resolve the underlying issue with your listener URL, or contact Absorb Support for assistance.
A Custom Date Range Is Not Accepted
A custom date range is not valid if the end date is before the start date. Choose an end date that is on or after the start date.
Current Limitations
Keep the following limitations in mind when monitoring and retrying Webhook deliveries:
- Failed deliveries can be retried one at a time only. Bulk retry is not available.
- Payload and error details are available for failed deliveries only.
- Only the most recent retry attempt is recorded for each delivery. A history of every individual attempt is not available.
- Each delivery can be retried manually up to five times.
For bulk recovery or deliveries that have reached the retry limit, resolve the issue with your listener URL or contact Absorb Support.
Comments
Article is closed for comments.