Webhook Events for Online Payments in Lighthouse Business Manager

Description: Learn how to work with Webhook events in Lighthouse Business Manager.

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

---

After navigating to the Webhooks page, you will see a table view of configured Webhooks.

Webhook Events - Column Breakdown

Each Webhook is listed as a row with the following column information:

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

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

Search and Filter Webhooks

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

• All
• Active
• Inactive

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

List of Webhook Events

Webhook events are built into the system by Shift4. The list below shows the currently supported events. 

Name	Description
SALE	Completion of a transaction between two or more parties
REFUND	Repayment of a transaction
DISPUTE	Occurs when an account owner contacts their bank to contest a payment to the merchant The webhook event will show disputes with a status of ‘Lost’ only.

Webhook Event Detail

To see the events that each Webhook contains, click on the specific row of the Webhook on the Webhooks page.

Once done, 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 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. These are:

• 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, click on the specific event listed in the table.
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. 

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" button at the bottom of the screen to confirm those changes.
It is also possible to delete a webhook configuration by clicking the "delete" button at the bottom right of the screen. 

Please proceed to the next article on this topic: Webhook Fields.