Webhook

This action allows you to make HTTP Request to any external service you want. This is useful to send information from the bot to another service or to fetch information from another service and use it in the bot.

tip

Before utilizing this action you'll need technical knwoledge about HTTP request and their parameters.

How this action works

Here are some explanations of how this action operates and its limitations:

• The bot always executes this action synchronously, meaning it waits until the request receives a result (either success or failure) before proceeding to the next step. If you have multiple webhook actions one after the other, they will be executed sequentially, not in batches.

• The timeout for the query is set internally to 10 seconds. Any long-running query will fail beyond this duration.

• The bot will continue even if your webhook action fails for any reason.

• It's your responsibility to handle the response, whether success or failure. You'll need to specify variables to store the request results. Then, it's up to you to use these variables later in the bot, for instance, as a condition in a choice block.

How to use it

Request parameters

The only mandatory parameter is the URL. You can directly add query parameters to it:

or use the helper:

All other parameters (headers and body) are optional. You can add them using the same logic, using the "add header" or "add body" buttons in the top right corner.

tip

You can insert variables to send previously stored information in any fields: URL, params, header, or body. Just click the small variable button on the right.

Once you have chosen the right method, you can click the Test URL button. If the request is successful, a small "eye" button on the right side will appear, allowing you to have a quick look at the response layout:

Request validation errors

When setting and testing the action, you may encounter different types of errors:

We process your requests on our server and identify common errors:

Type	Reasons	Action
MissingParameter	Missing url or method	Double-check that either the URL and the method are correctly specified.
BadRequest	Invalid URL, body, params or header	Check the validity of each parameter. Use clients like Postman to check your parameters.
BadResponse	Response status different from 200 or response not in JSON format	Check your server status.
KeyError	Specified path does not match response payload	Double check the validity of the path you entered in the webhook action for each variable

Parsing and storing requests response in variables

Once your request receives a successful response, you can choose a variable that will store the result. You can also select the part of the response you want to store by using the "path" helper:

If you are trying to select an array as a value, the helper will suggest using the flatMap function, which gives you the possibility to extract any value from the array.

For instance, let's say the data structure of your request's response looks like this:

{
  "products": [
    {
      "id": 1,
      "title": "iPhone 9",
      "description": "An apple mobile which is nothing like apple",
      "price": 549,
      "rating": 4.69,
      "stock": 94,
      "brand": "Apple",
      "category": "smartphones",
      "images": [
        "https://cdn.dummyjson.com/product-images/1/1.jpg",
        "https://cdn.dummyjson.com/product-images/1/2.jpg"
      ]
    },
    {
      "id": 2,
      "title": "iPhone X",
      "description": "SIM-Free, Model A19211 6.5-inch Super Retina HD display with OLED technology A12 Bionic chip with ...",
      "price": 899,
      "rating": 4.44,
      "stock": 34,
      "brand": "Apple",
      "category": "smartphones",
      "images": [
        "https://cdn.dummyjson.com/product-images/2/1.jpg"
      ]
    }
  ]
}

And you want to store in the variable webhook success an array of product titles only:

["iPhone 9", "iPhone X"]

Using the following value will match your need:

If you want to access the category of the second product item, you can use this path instead:

products[1].category

tip

You can store multiple parts of the response in different variables. This will prevent you from running the same webhook request multiple time

Dealing with failed requests

It's possible that even after correctly setting up your webhook action, it fails occasionally (server errors, parameters not handled correctly, etc.). If your bot's behavior depends on the result of the request, it's important to handle errors. The bot will store any errors in the variable you specified, or will use the variable last webhook failure:

It's up to you to handle this error or not. The best way is to create a specific variable for each webhook, and then check via a choice block if the variable contains a message:

Test your request in the simulator

You should always verify if your bot is behaving as expected via the simulator, ensuring both successful and failed requests are handled correctly. When the simulator reaches a webhook action, unlike the real bot, it will pause and prompt you to specify what the request should resemble:

• Fake success: It will prompt a modal to specify the payload of the successful request. Then, it will utilize each path you have specified in the webhook action to parse and store the corresponding variables. Note that if you are storing into a list-type variable, the simulator will expect the payload you provide to contain an array at the right path. If not, an error will be displayed in the modal, preventing further progression.

• Fake failure: It will display the same modal and allow you to specify the payload to be saved in the fail variable you specified in the action.

• Trigger real webhook: It will proxy your request to our server and return the actual result. This can be useful for checking if everything works fine, but remember that it will make a real HTTP request. If you plan to add a user to your CRM via the webhook action, using this choice in the simulator may add unwanted data to your CRM.