The purpose of this documentation is to present the API call configuration bubble, and to help you set up your API calls from Ideta's chatbot to an external tool.
In general, we recommend that you always test your API calls before deploying them on a channel, in order to ensure the validity of the settings.
You can test our APIs in Postman
In the "Request headers" part, it is possible to enter a header of your choice.
If the authentication method of the called API differs from the one proposed above, please contact the support.
The URL of the targeted API.
You have the possibility to format your url with dynamic values from the conversation data.
Please note! To be valid, the URL must be entered without spaces.
To find out what type of request you should send, you can refer to the documentation of the targeted API.
The most common types of requests are:
In a POST, PUT or PATCH request, you can attach a body to your request, containing the data you want to send. As for the URL, this data can come from the conversation.
The JSON format requires the following syntax standards to be respected:
Once the request has been made, the "next Bubble" allows you to redirect to the next part of the conversation.
If an error occurs during the process (API not available, authentication error, error in storing the response, etc.) the "Fallback Bubble" redirects to an appropriate conversation bubble to inform the user.
Temps d’attente maximum après lequel la conversation est automatiquement redirigée vers la Bulle de secours.
If you want to retrieve data from the API response you can enable the Store Response option to access the rest of the form:
This is the key on which the response data will be stored.
Assuming we want to retrieve the values of "city" and "closing_hours". The properties of the key can be named differently from the properties referred to in the answer.
The storage key will be configured as follows:
The settings will be as follows:
Once the API call is successful, you can use the stored data like any other key in the following bubble settings.
Assuming that we want to retrieve the list of products keeping only the name and the price, the storage key will be configured like this:
To retrieve the list containing the targeted data, you must also define the Path of the list (mandatory). This field indicates its position within the response.
Storing a list after an API call can be useful to automatically generate quick responses, carousels or lists.