Navigating Webhooks within Lighthouse Business Manager

Description: Review how to navigate webhooks within Lighthouse Business Manager below. 

For an in-depth guide on Online Payments Webhooks, view the Online Payments Webhooks Guide.

---

Column Breakdown

After navigating to the Webhooks page, you will see a table view of configured webhooks. Each webhook is listed as a row with the following column information:

• Name: Name of the webhook (optional)
• URL: Public web address of the customer’s HTTP server (that receives the webhook request)
• Environment: States whether the webhook is in the Production or UAT environment
• Status: Shows current status of the selected configured webhook. (active or inactive)
• Last 7 Days: Count of webhook calls within the prior seven days • Error Rate: Percentage of errors vs success calls

Tip: You can sort the information in the columns by clicking on the column header name.

Searching and Filtering Webhooks

The events can be filtered by status using the Status box in the top-left corner of the screen. The options are:

• All
• Active
• Inactive

There is also a search box in the top-right corner of the screen to allow you to search for a specific webhook URL if desired.

Webhook Event Details

To see the events that each webhook contains, click on the specific row of the webhook on the Webhooks page. When a row is selected, a detailed webhooks event window will appear.

To close this window and return to the main Webhooks page, click the arrow in the top-left corner of the screen.

The events window provides summary information about the webhook at the top of the screen. This includes:

• Status: Status of the webhook (Active, Not Active, Disabled, or Not Registered)
• Listening For: Shows a count of events. Hover over the box to see the name of the event
• Signing Secret: Click Reveal to show the secret and an option to copy the text to your local clipboard

The main section of the events window contains two tabs:

• Logs
• Settings

The logs tab shows a list of events for the webhook which can be filtered by Period and/or Status.

Shown in a table format, the logs list the following:

• Event: Name of the webhook event type
• Status: Lists whether the event ran successfully or failed
• Date: Date the request was initiated

There is also an option to resend the event on the right side of the table.

To view the detailed request information for any event:

1. Click on the specific event listed in the table.
2. A slider will pop up on the right side of the screen showing the HTTP response code and request body with an option to copy to the clipboard.
3. To close the slider, click the X in the top-right corner of the screen.

The Settings tab shows more details regarding the webhook itself, including General Settings: 

• Active Toggle: Set the webhook to active or inactive
• Name: Name of the webhook configuration
• Webhook URL: Public address of the HTTP server
• Description: Free text description of the webhook Events
• Events: Select which events the webhook should track

If any changes were made, click the SAVE CHANGES button at the bottom of the screen to confirm those changes.

To delete a webhook configuration, click the DELETE button in the bottom-right corner.

Resending Webhooks

Occasionally there may be a need to resend a webhook event, for example if a failure took place.
Within LBM a user can choose to resend a webhook individually or in bulk action.

Note: If a webhook event fails, there will be 5 automatic retry attempts. For more information on retries please refer to ‘Retries’ under the Request Handling section of this guide.

To manually resend a webhook, follow these steps:

1. Log in to your Lighthouse Business Manager (LBM) and select Developers from the left-hand navigation pane.
2. Select the Webhooks tab located at the top of the main screen.
3. Select a webhook from the onscreen list by clicking on it. A detail window will open.
4. Filter the webhook event by using the following filters:
   • Period: Select the date or date range you with to use
   • Status: Select All, Success or Failed
   • Events: Select which event type you wish to display
   • Resent: Select All, Yes or No
5. To resend an individual webhook, select the RESEND option on the right side of the main screen
6. To resend a group of webhook, select the RESEND ALL option to the right of the status bar
   
   

When either resend function button is pressed, a wheel symbol will rotate next to the resend / resend all button indicating the function has been activated.

Once the webhook resend function has been triggered, the process to resend a webhook will begin. Depending on the amount of webhooks being re-sent, this may take a few minutes. However once completed the status and date stamp of the webhook will update with the new values.

For example, the above image shows webhook events that failed on August 30th. Once the failure took place, 5 automatic retries then occurred, after which the events remained in a failed state.
The top webhook event was then individually re-sent on September 27th, and the attempt was successful.
As shown in the image below, the status indicator then updated to  show the success, and the Resent Date column was populated with the date and time the resend action took place. The Date column stays populated with the original attempt date.

Please proceed to the next article on this topic: Receive Webhooks.