# 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**
1. In the sidebar of the interface, find and click on the **Settings** menu.
2. Within the Settings menu, click on the **Webhook Setting** tab on the left.
**Accessing the Create Webhook View**
1. Go to the Admin Console.
2. Click on the **Settings -> Webhook Settings** tab on the left.
3. You'll find the **create Webhook** button on the right.
**Setting Up a Webhook Endpoint from Another System's Configuration Interface**
1. Access the configuration interface of the system that will send webhook.
2. 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**
1. Press the **Create** button to continue with the action.
2. 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**
| **Events** | **Description** |
| ---------------------------------------------- | ---------------------------------------------------------------------- |
| USER\_LOGIN | when a user successfully logs into the system. |
| USER\_LOGIN\_FAILURE | when a user's login attempt fails. |
| USER\_CREATED | when a new user account is created. |
| USER\_MODIFIED: | User account details are changed. |
| USER\_DELETED | User account is removed. |
| USER\_ENABLED: | Disabled user account is reactivated. |
| USER\_DISABLED | User account is deactivated. |
| USER\_EMAIL\_VERIFIED | User's email is confirmed. |
| USER\_MOBILE\_NO\_VERIFIED | Verifies a user's provided mobile phone number. |
| USER\_IDENTITY\_ADDED: | Extra identity, like a social media profile, to a user account. |
| USER\_IDENTITY\_REMOVED | Linked identity is disconnected from account. |
| USER\_PASSWORD\_CHANGED | User updates their password. |
| EMAIL\_CHANGED | User changes their email address. |
| USER\_PASSWORD\_RESET\_INITIATE: | User starts password reset process. |
| USER\_PASSWORD\_RESET: | User successfully resets password. |
| USER\_BLOCKED | User's account is temporarily blocked. |
| COMBINEDLOGOUTTOKEN\_CHECKED | Verification of special code for secure logouts |
| TOKEN\_RENEWEDCODE\_OBTAINED: | Code to renew permission is acquired. |
| ACCESS\_TOKEN\_OBTAINED: | Permission to use something is obtained. |
| APP\_CREATEDAPP\_MODIFIED: | New app is made, or an existing app is changed. |
| APP\_DELETED: | App is removed. |
| ROLE\_CREATEDROLE\_UPDATED: | New user role is made, or existing role is changed. |
| ROLE\_DELETED | User role is removed. |
| PERMISSION\_CREATED | New permission is given to the user. |
| PERMISSION\_UPDATED | Permission is changed. |
| PERMISSION\_DELETED: | Permission is removed. |
| GROUP\_CATEGORY\_CREATED | New group type is defined. |
| GROUP\_CATEGORY\_UPDATED | Group type is changed. |
| GROUP\_CATEGORY\_DELETED: | Group type is removed. |
| PROVIDER\_CREATED | Signifies the addition of a new authentication provider to the system. |
| PROVIDER\_UPDATED | Indicates modifications made to an authentication provider's settings. |
| PROVIDER\_DELETED | Denotes the removal of an authentication provider from the system. |
| GROUP\_NEW\_USER\_ADDED | Records the addition of a new user to a group. |
| INVITE\_USERRE\_INVITE\_USER | Invitation is sent again to a user |
| INVITE\_ACCEPTEDINVITE\_REVOKED | Invitation is accepted or canceled. |
| USER\_CREATED\_WITH\_INVITE | User accounts are made using an invitation. |
| GROUP\_USER\_ROLE\_UPDATED | User's role in a group is changed. |
| GROUP\_USER\_REMOVED | User removed from a group. |
| TENANT\_CREATED | Records the creation of a new tenant. |
| GROUP\_CREATED | Marks the creation of a new group. |
| GROUP\_UPDATED | Changes are made to the group's details. |
| GROUP\_DELETED | Group is removed. |
| SMS\_SENT | Marks the sending of an SMS message. |
| EMAIL\_SENT | Indicates the sending of an email. |
| IVR\_TRIGGERED | Interactive voice response is activated. |
| PUSH\_SENT | Push notification is sent. |
| SCOPE\_CREATED | Signifies the creation of a new scope. |
| SCOPE\_UPDATED | The scope's details are changed. |
| SCOPE\_DELETED | Scope is removed. |
| SCOPE\_DEC\_CREATED | Decision related to a scope is made. |
| SCOPE\_DEC\_UPDATED | Changes are made to decision related to scope. |
| SCOPE\_DEC\_DELETED | Decision related to a scope is removed. |
| REGISTRATION\_FIELD\_CREATED | Marks the creation of a new registration field. |
| REGISTRATION\_FIELD\_UPDATED | Registration field has changed. |
| REGISTRATION\_FIELD\_DELETED | Registration field is removed. |
| GROUP\_TYPE\_CREATED | Signifies the creation of a new group type. |
| GROUP\_TYPE\_UPDATED | Indicates updates made to an existing group type's detail. |
| GROUP\_TYPE\_DELETED | Group category is removed. |
| HOSTED\_PAGE\_CREATED | New hosted page is made. |
| HOSTED\_PAGE\_UPDATED | Hosted page's details are changed. |
| HOSTED\_PAGE\_DELETED | Hosted page is removed |
| TEMPLATE\_CREATED | Marks the creation of a new template. |
| TEMPLATE\_UPDATED | Changes are made to template. |
| TEMPLATE\_DELETED | Template is removed. |
| CUSTOM\_TEMPLATE\_CREATED | New custom template is made. |
| CUSTOM\_TEMPLATE\_UPDATED | Changes are made to custom template. |
| CUSTOM\_TEMPLATE\_DELETED |
Custom template is removed.
|
| WEBHOOK\_CREATED | New webhook is created. |
| WEBHOOK\_UPDATED | Webhook is changed. |
| WEBHOOK\_DELETED | Webhook is removed. |
| CAPTCHA\_CREATED | New CAPTCHA is made. |
| CAPTCHA\_UPDATED | Changes are made to CAPTCHA. |
| CAPTCHA\_DELETED | CAPTCHA is removed |
| PROFILE\_IMAGE\_UPDATED | User's profile image is changed. |
| PROFILE\_IMAGE\_REMOVED | User's profile image is removed. |
| MFA\_REQUIRED | Users need to use multi-factor authentication. |
|
PHYSICAL\_VERIFICATION\_CONFIG
| Settings for physical verification are defined. |
| PHYSICAL\_VERIFICATION\_REMOVED | Physical verification settings are removed. |
| PHYSICAL\_VERIFICATION | Process of physically verifying something is started or completed. |
| FLOW\_CREATED | when a new Blueprint is created. |
| FLOW\_UPDATED | Existing Blueprint is updated. |
| FLOW\_DELETED | Existing Blueprint is Deleted |
| MFA\_INITIATED | The process of Multi-Factor Authentication begins. |
| MFA\_RE\_INITIATED | Restarting Multi-Factor Authentication |
| MFA\_VERIFIED | Multi-factor authentication is successfully confirmed. |
