Webhook Settings

A webhook is a real-time communication method used by applications to instantly share event-driven data.

When a specific event occurs in one application, it sends a message, often in the form of an HTTP POST request, to a predefined URL in another application.

This allows for immediate updates, automated actions, and seamless integration between different systems, enhancing efficiency and enabling timely responses based on events.

Accessing the Webhook Setting Tab

In the sidebar of the interface, find and click on the Settings menu.
Within the Settings menu, click on the Webhook Setting tab on the left.

Accessing the Create Webhook View

Go to the Admin Console.
Click on the Settings -> Webhook Settings tab on the left.
You'll find the create Webhook button on the right.

Setting Up a Webhook Endpoint from Another System's Configuration Interface

Access the configuration interface of the system that will send webhook.
Use the configuration interface to specify the following:
- The URL where data should be sent as part of the webhook.
- The specific events or actions that should trigger the webhook.
- Any authentication or security details required for the webhook to function securely.

To Proceed or Cancel an Action

Press the Create button to continue with the action.
Click Cancel if you wish to abort the process.

Webhook Name

The name of the webhook you set up is crucial for identifying its purpose and function.
This name helps you easily recognize which webhook is responsible for handling specific events or tasks.
Choosing a descriptive and meaningful name for your webhook can streamline your workflow and organization.

Webhook Events

Webhook events refer to the specific occurrences or triggers that prompt your webhook to send notifications or data to a designated endpoint.
These events can range from user actions, such as making a purchase or signing up, to system updates, like changes in data.

Notification Type

REST – It will notify the external system by the API

URL

The URL is the web address where your webhook sends its notifications or data.
It acts as the bridge between your webhook and the receiving application or system.

API Key

To provide an additional layer of security for your webhook's communication, an API key can be utilized.
An API key serves as a unique identifier and authentication token, allowing the receiving end to verify the legitimacy of incoming requests from your webhook.

Webhook Events

Webhook events allow systems to communicate in real-time, reducing the need for constant polling or manual synchronization.
They play a crucial role in integrating and automating processes between different platforms and systems.
The types of webhook events you'll encounter depend on the applications you're using and the interactions you want to track or automate.
Webhook events are specific occurrences or actions that trigger the sending of data from one system (the webhook provider) to another system (the webhook receiver or listener).
These events are used to notify the receiver in real-time about changes or updates that have occurred in the provider system.
Webhook events vary depending on the context and the systems involved.
Here are some common examples of webhook events:

Webhook Request Body

Webhook request body that contains the below.

{

event_time: Date;

event_type: string;

current_context: any;

data: any;

}

A change in the event type will result in a corresponding adjustment to the data within the webhook event, ensuring that the conveyed information remains accurate for the specific event.

Available webhook events

PreviousCustom Template NextConnectors

Last updated 6 months ago