Webhook

Receive real time data from 3rd party applications into the flow

The webhook step is designed to receive real-time updates from a third-party platform while a user is in a conversation. It allows you to wait for updates from another platform and redirect the user to the next step based on the data received from the third party. This feature is particularly useful in scenarios where you need to synchronize actions with external events or systems.

For example, let's say you have sent a payment link to a user, and you're unsure when the user will make the payment. By configuring a webhook in the payment gateway, whenever the system receives an event from the payment gateway (e.g., payment confirmation), the chatbot will automatically execute the next step that you have configured in the flow. This allows for seamless integration and automation of processes.

Getting the Webhook End Point

Whenever you add a step, it creates a unique webhook for that step as shown below. You need to send a data payload to this URL in either JSON or query string format. After sending the payload, click on the refresh button so the system can fetch and map the data inside the flow. This data will then be available for further use in the attributes.

Field Mapping

Field mapping assists the system in identifying the channel and the contact. Therefore, you must select the channel, mobile number, or email mapping that helps identify the contact. Based on this mapping, we can execute further steps.

Please note that further steps will only be executed if the user is already engaged in the flow. A flow or step cannot be triggered if the user is not in the flow.

Once a payload structure is mapped, you must always pass the data in the same structure. If there are any changes in your data structure, then you must redo the field mapping.

You can refer to the data that is passed from the 3rd party in the Attribute under Webhook as shown below