Webhooks

Webhooks allow the voice bot to either interact with external systems. With webhooks, the voice bot can either retrieve up to date information such as what products are available, appointment slots etc. as well as send/submit gathered/collected information such as when the user completed a transation/booking.

How To Configure Webhooks

Webhooks can be directly configured within a function/action the voice bot executes by simply toggling the webhook switch and providing the Webhook URL as shown below:

The voice bot will then submit as a body in a POST request the collected data specified as parameters.

Post Processing

In case the webhook is used to retrieve data, it is sometimes needed to transform the data such as filtering items, or formatting them.

If post processing is needed, the Post hook JS function call field can be used to specify the function name of a function that should be called right after the webhook retrieved the data.

The function parameters will be a nested JS object with the REST data retrieved from the webhook.

Programmatic Execution Of Webhooks

Webhooks can also be programmatically executed in any JS code snippet at any point of time as follows:

function myFunction(params) {
    response = webhook("https://mydomain.com/apiEndpoint", {"sample": "data"});
    return response;
}