Webhook

Managing webhooks on your platform

SBO > Other > Webhook

• Definition

• Webhook Dashboard

  • Filters

  • Webhook Cards

• Sorting

• Adding a Webhook

• Webhook Handling Responses

  • Monitoring and Logging

Definition

The webhook feature facilitates seamless communication between our platform and third-party applications. It enables third-party services to receive notifications about events occurring on our platform, allowing them to respond accordingly.

Webhook Dashboard

Filters

On the dashboard, it is possible to filter by creation date (Figure 1).

Figure 1

To select a date range, click on the "From" and "To" fields. This action will display a date picker, allowing you to choose the desired period with ease. (Figure 2)

Figure 2

Webhook Cards

Each card presents its title, status, creation time, and date. (Figure 3)

Figure 3

Users are provided with the flexibility to personalize the display format of items according to their preferences. This includes the option to switch between list (Figure 5) or card (Figure 6) views for a tailored browsing experience.

Changes like these are initiated by the user pressing the button illustrated in Figure 4 in the right corner of the webhook dashboard.

Figure 4

Figure 5

Figure 6

Sorting

The webhook dashboard provides operators with tools to facilitate efficient webhook management by allowing items to be sorted based on specific criteria:

1. Creation Date: Sort items according to their creation timestamp.

2. Update Date: Sort items based on the most recent updates.

3. Smart Sorting: Automatically prioritize and organize items by ID.

These sorting options help streamline the management process, ensuring that operators can quickly and effectively access and organize webhooks.

All of these actions are located in the top right corner (Figure 7)

Figure 7

Adding a Webhook

To initiate an action and add a new webhook, the operator must use the button illustrated in Figure 8.

Figure 8

To add a new webhook, the following information is requested (Figure 9):

Title: The name that will be displayed in the webhook dashboard.

URL: The endpoint where the information will be sent.

Triggers: Define the business events that will notify third-party applications.

Figure 9

Use case: Consider the scenario where a webhook is configured for the "User Creation" event. When a new user is created, the system will send a notification to the designated webhook URL, indicating the successful creation of the user. This automated notification is beneficial as it allows for real-time updates and seamless integration with other systems.

There is also an option to set the webhook status to either enabled or disabled (Figure 10).

Figure 10

Webhook Handling Responses

When a webhook is triggered, it is crucial to handle the responses accurately to ensure smooth operations and seamless integration. The following are the statuses that might be encountered:

• Error: Something went wrong during thee dispatch. (Figure 11)

Figure 11

• Sent: The dispatch was successfully sent. (Figure 12)

Figure 12

Monitoring and Logging

To maintain effective integration, it is recommended to consistently monitor and log webhook activities. This helps in diagnosing issues quickly and ensures the integrity of the integration process.