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.