User Guide

2021

Summary
1. My first Bot 4
2. Types of bubbles 11
Text bubble 12
“Quick replies” bubble 12
Media bubble 14
Button bubble 14
Carousel bubble 17
List bubble 18
3. Automations (mapping of the bubbles) 20
Direct linking 20
Text data input processing 20
Invisible Bubble 21
Triggered actions 22
4. Data 23
Creation of variables 23
Data Operations 25
5. Artificial Intelligence 27
Connect your Dialogflow account 27
Set up NLP 29
6. Templates Management 31
Template creation 31
Template Import 32
7. Chatbot deployments 33
Test 33
Facebook Deployment 34
Web Deployment 36
Script Integration 40
8. Configuring an API call 41
Request configuration 41
Using bot with API 43
Storage and use of response data 49
Storage in an object 49
Storage in a list 51
9. Third party products 54
Create a zap to receive the data by email at the end of the bot 54
Facebook ads 56

2
 2021

1. My first Bot
We are going to create together our 1st Web bot!

● Click on the button create a bot:

Then rename it:

● You have the possibility to use a template depending on your use case, or begin with an
empty bot.

● When you open the new bot, there is already a “Hello” bubble. Click on it on the left list :

3
 2021

Change the text to “Hello and welcome to my 1st bot”

NB: the changes are saved automatically

● In the automation column (on the right), select this icon:

Select “Go to bubble”:

Add a new bubble and name it “name?”.

This will link itself directly with the “Hello” bubble.

Then select the new created bubble in the left column,

modify the text in “What is your name?”.

● In the automation column, select “Save user’s text Input “:

Add a new data key “name”.

● Create a bubble that you name “choice”.

NB: don’t choose any “check format” or any “bubble if invalid”. When the user responds to this
question, the bot will save their response as “name”

4
 2021

Select the new “choice” bubble in the left list.

In the model field, select quick replies:

(See section 2. Types of bubbles to see other types of

model).

Erase the introductory text and click on the button on the right to insert a data key:

Select @name then add a space and type “, are you already a customer?”.

NB: The bot will use the name previously given by the user.

Click on the little « + Response 1 »:

5
 2021

Replace the title with “Yes”.

Replace the picture URL with:

https://res.cloudinary.com/meet-ideta/image/upl
oad/v1554213601/thumbs-up-sign_1f44d_tzg4tb.
png

Then Create a target bubble “customer button”.

Click response 2, replace the title with “No”.

Then replace the picture URL with:

https://res.cloudinary.com/meet-ideta/image/upl
oad/v1554213601/thumbs-down-sign_1f44e_ltbv
qw.png

Finally, create a target bubble “customer offer”.

● Select the bubble “customer button” in the left column, then select the button model.

Delete button 2, then open button 1.

6
 2021

Select type Web URL.

Then modify the title and complete the URL:

● Select the bubble “customer offer” in the left column, then select the “Carrousel” model:

NB: no need to delete or modify the intro text, that is used only for Google bots.

7
 2021

Click on element 1 and go to the buttons.

Here, button 1 will direct the user to an external page and

button 2 will direct the user to a subscription bubble

You can choose a type of default action, or delete it:

8
 2021

Now we are going to test our bot in the sandbox.

● Click the button cockpit in the left-hand column:

NB: You can use the bot in the space without deploying the bot on the internet.

9
 2021

2. Types of bubbles

10
 2021

Text bubble

In the case of a web bot, you can use some html tags:

- To modify the layout (<ul>lists</ul>, line breaks <br>, ...)

- To format the text (<b>bold</b>, <i>italic</i>, <u>underlined</u>,...)

“Quick replies” bubble

The introductory text is the question to which the quick replies answer.

There are 2 modes:

- Manual mode allows you to create by yourself the quick replies

- Automatic mode allows you to generate automatically these responses by choosing a
previously obtained list by API (see section: 7. Configuring an API call).

11
 2021

For each button of quick replies, you can modify the text and choose an icon by indicating the
URL of it (or simply upload it with the attachment icon).

The target bubble is the one that will be displayed after the choice of this response by the user of
the bot.

NB: You can directly create a new bubble and choose it (you will be able to modify this bubble
later on).

The data handling section allows you to save some information (text-based or numerical) or to
generate some calculations on some data (see section: 4. Data).

12
 2021

Media bubble
The bubble displays only the media together with a button (optional).

If you want to add some text, you will have to create another bubble before or after.

You can display:

● a Jpeg, Gif or Png image

● a posted video in .mp4 or youtube video (In the case of a Facebook bot, youtube videos
are not supported)
● a posted audio attachment in the format .mp3 and .m4a (In the case of a Facebook bot,
audio attachments are not supported)
● a google map (web bots only)
c.f. https://developers.google.com/maps/documentation/urls/guide

Button bubble

The title of the bubble can be modified.

You can have up to 4 clickable buttons.

There are 4 types of buttons:

1. Web URL button

You can change its title then enter the

URL to which

the user is returned.

13
 2021

In the case of a bot on Facebook messenger, we also choose the size of the display window:

Compact, large or full

2. A triggered bubble button

You can change the title text.

The target bubble is the one that will be

displayed after the voice of this answer by
the bot user.

NB: You can directly create a new bubble

and choose it (you can modify this new
bubble by selecting it in the list of bubbles
which is on the left).

The “Data manipulations” section is used to record information (textual or encrypted) or to

generate calculations on data (see section: Data Operations).

14
 2021

3. Authentication button

You can change the title text then choose the

service to log in: Facebook or Google.

You have to define the next bubble in case of

success or failure of the authentication, as well
as a profile storage key.

4. Call button

You can change the title text.

This button will redirect the user to a

messenger call for a Facebook bot.

The 5th button allows you to make a share on Facebook.

15
 2021

Carousel bubble

There are 2 modes:

● Manual mode allows you to create by yourself the quick replies

● Automatic mode allows you to generate automatically these
responses by choosing a previously obtained list by API (see section: 7.
Configuring an API call).

For each element, you can modify the title, the subtitle, the image by indicating the URL of it

NB: it is recommended to put up the images rather than get them from an external site.

You can then choose or not a default action:

● open an external URL

● display another bubble*

* the target bubble is the one that will be displayed after the choice of this response by the user
of the bot. You can directly create a new bubble and choose it (you will be able to modify this
bubble later on)

You can create up to 3 buttons (see section :Button bubble).

16
 2021

List bubble

There are 2 modes :

● Manual mode allows you to create by yourself the

quick replies
● Automatic mode allows you to generate automatically
these responses by choosing a previously obtained list by
API (see section: 7. Configuring an API call).

You can create up to 4 elements.

For each element, you can modify the title, the subtitle, the image by indicating the URL of it.

NB: It is possible to upload the image with the attachment icon.

You can then choose or not a default action:

● open an external URL

● display another bubble*

* the target bubble is the one that will be displayed after the choice of this response by the user
of the bot. You can directly create a new bubble and choose it (you will be able to modify this
bubble later on)

You can create then 1 button (see section: Button bubble).

17
 2021

NB: the target bubble is the one that will be displayed

after the choice of this response by the user of the bot.

You can directly create a new bubble and choose it

(you will be able to modify this bubble later on)

The Data manipulation section is used to record

information (textual or encrypted) or to generate
calculations on data (see section: Data Operations).

You can change its title and enter the URL to which the
user is sent.

In the case of a bot on Facebook Messenger, we also choose the size of the display window:

Compact, tall or full

18
 2021

3. Automations (mapping of the bubbles)

Direct linking

To directly link 2 bubbles, simply choose the next

bubble.

NB: You can directly create a bubble.

Text data input processing

Here, we will decide what to do with the entry of the user who responds to our bubble.

Detect Words

You can decide to set some triggers; these are some

words which trigger and send the user to some other
bubbles.

NB: there is not any AI in this part.

19
 2021

Detect intents with NLP

Queries can be processed thanks to AI, by being

processed by an NLP service.

For example, via DialogFlow.

Save User’s text input

There is also a possibility to save the user’s entry.

You have to choose:

- Which data you want to save the entry

- The bubble that you will display next
- An optional format check (is this an email address,
a phone number or a date)
- If the format doesn’t match, the user will be sent
back to another bubble (possibly the current bubble)

Fallbacks

In both cases, it is recommended to use fallbacks. This will

allow you to display a message then redirect the user
towards the appropriate bubble if no trigger or no
DialogFlow intent is activated by the customer’s input.

Invisible Bubble
It is possible to create an invisible bubble, it means a bubble that will not appear in your
conversation, in order to shift the conversation or to perform operations on data keys.

NB : your bubble becomes invisible when you let it on the “invisible bubble” icon.
Then you must not let this bubble on another section, nor let a bubble which is not
invisible on the “invisible bubble” section.

20
 2021

Switch based on conditions

You can switch your chatbot responses depending on the refill of certain conditions that you can
define : exist, does not exist, equal to, less than, different from, etc.

If the condition is TRUE, you can move to the next comparison or go to the bubble of your choice.

If the condition is FALSE, you can move to the next comparison or go to the bubble of your choice.

Data modifications

It is possible to perform modifications on predefined data from a bubble.

NB: you can also send your bubble information to an external API. Check out our section
Configuring an APi call for more information.

Triggered actions
Send an email notification

It is possible to send an email notification to the email address of your choice, in order to be
informed of an action made by a user on your chatbot.
This could be the arrival of a new lead, collect information concerning a customer, be informed
that a customer wants to contact the support, etc.

● Start by clicking on “add a background action”:

● Choose the moment when your email will be

triggered, give a name to your action and then
choose the type “Send an email”.

● Enter the sender and the recipient(s).

21
 2021

● Enter the subject of your email in the “title”

bar.

● Then enter your email body using HTML

format.
(Some software edit your text in html like
HTML editor, Notepad++, Sublime Text etc.).

22
 2021

4. Data

Creation of variables
It is possible at any time in the bot to create "Data", that is to say to store values ​in variables.

For example :

● First Name = Fabien

● Favorite color = rouge
● NumberCommands = 12

In the column on the left, choose the Data Manager panel.

You will then have access to the list of existing variables and the possibility of creating new ones:

23
 2021

There are 3 types of data:

- Conversation data:
This data is unique to each user of the bot.

You can create data keys to save data like the first name, the last name, the company, the line of
business of the user via text data input processing > save user's text input, or via Data
Operations.

- Bot data:
Each data is the same for all conversations.

You can create data keys to save data like the number of users working in a
particular sector, via Data Operations.
It is important to indicate the type of data (text, number, boolean) for each
key to perform the operation.

- System data:
They are automatically filled according to the deployment channel.

For example, Facebook profile information (first and last name).

To add a new variable, click on add a key, a MyNewKey is

created.

You can then modify its name, the type of value as well as its
value in the case of bot data.

24
 2021

NB: The keys names must not contain spaces or special characters.

Data Operations
It is possible to perform a number of operations on bot data:

For that you have to affect one of these operations to a data key created in bot data, for example
to save the number of users associated with a number type data key.

Example: You add to the variable compteur_health the number “1”, which means that each user
who has clicked on the answer “Health” is accounted.

25
 2021

These operations can be carried out at several times:

● When clicking on the quick response

● Between the display of 2 bubbles

These operations can also be used for conversation data in order to affect a value to a data key.

Example: You affect the variable customer_activity the value “Health”, which means that the user
who has clicked on the answer “Health” works in the health sector.

26
 2021

5. Artificial Intelligence

In the AI section, you can set up the natural language processing of your chatbot, using a NLP
service such as DIALOGFLOW.

If you want to use natural language processing for your chatbot, I

recommend you to create a “My Dialogflow Bot” template that
shows you how to use and set up artificial intelligence.

Connect your Dialogflow account

● Above all, you need to connect Dialogflow to your Ideta account

To do that, go on “NLP services” on the AI tab, then click on “options”

27
 2021

● On this window, you dispose of two methods of connection : by Google, or by loading a

JSON.

Then, you have to create an agent on your Dialogflow account. For that you just need to
click on the link “Create a Dialogflow agent”. Follow the instructions and choose the
location you want. It allows to use agents from parts of the world proposed by Dialogflow.

You’ll find the project ID on your Dialogflow account, in the general settings of your agent :

28
 2021

Set up NLP
Create intents

To set up language recognition, you need first to add intents. They correspond to what your user
asks.

● Go to the “intents” tab, then click on “New intent”:

● Give a name to each created intent and add example phrases, which correspond to the
different ways to formulate the same intent.

Keep adding example phrases to make your bot smarter !

Create entities

Entities are linked with the intents you have created. They gather all values associated to an
element from your example phrase.

● Go to the “entities” tab, then click on “New entity”:

● Give a name to each entity and add all values associated to this entity, covering all what
implies your entity. You also can enter synonyms of your values.

29
 2021

● Then, go back to your example phrases from your intent and select with your pointer the
value corresponding to one of your entity. Tag the corresponding entity.

30
 2021

6. Templates Management

Click on Manage categories at the bottom left and then on Template options:

Template creation
In the Create template tab, select the bubbles to copy and give a name to the template:

31
 2021

Template Import
In the Load a template tab, select the template to copy.

NB: You can add a prefix that will be added to the name of each imported bubble if necessary.

We can for example create a template grouping all the bubbles of a bot in English and then
import this template (with a French prefix) into the same bot to facilitate the translation work.

32
 2021

7. Chatbot deployments

Test

Testing is the space where you can test the bot and its changes without having it be accessible to
others.

You can display any bubble by clicking on its name in the left column.

33
 2021

It is possible to delete the history and restart the conversation from the beginning:

Facebook Deployment

Connect Facebook account

To connect your bot to your Facebook page, you must first connect your Facebook account to
the platform:

in the Deployment tab, you will find the list of pages which your Facebook account is the
administrator:

34
 2021

The connect button has to be clicked before deployments:

Then synchronize with the sandbox:

The options button allows you to configure a number of features of the bot.

Persistent Menu

You can create a menu which will include a first of 3 responses then 2 level of 3 responses.

Example of menu which includes a button to restart the bot:

The chat button redirects you to Facebook messenger to speak with your bot:

35
 2021

Web Deployment
Here is how to deploy your bot on a dedicated web page or integrated on your page:

● Once your chatbot is ready, click on the “publish” tab:

You also can access it via the edit or test tabs:

● Click on “publish”:

If you have not registered your payment information yet, a pop-up is displayed so that you can
do it directly.

This address allows you to share your bot:

● Once your bot published, click on “Get your embed code”:

● Copy this script and simply add it to your website code.

36
 2021

Example of integrated bot :

Customization

In the publish tab, you also have access to all display and customization settings of the bot

You can customize your bot by putting your Logo, a bot avatar and a wallpaper on it. Just enter
the URL of the image to use:

37
 2021

The colors of the bubbles and texts are also adjustable:

Several interaction options are possible:

38
 2021

● Allowing free text will display the text entry bar permanently. If the option is unchecked,
the bar will only appear when prompted for user input.

● Authorize attachments allows you to add an

attachment with the icon at the entry text bar.

● Activate the relaunch button brings up a restart button at the top right of the page.
You can choose the target bubble when the conversation is relaunched

● Display former quick-replies keeps the quick response buttons visible

after the user has made their choice. This can facilitate the navigation
of the user since he does not have to start the conversation again to
change his choice.

● Authorize interaction with former buttons allows you to keep former

conversation bubbles active. The user can thus return to a former
question without relaunching the conversation.

● Delete conversation on page loading deletes the conversation in case of refresh or

removal of the page. Retaining it allows the user to keep track of exchanges.

● Delete conversation on restart delete the conversation in case of relaunch of the

conversation by the relaunch button which restart it.

● Display the typing indicator shows you that your interlocutor is writing.

● Display send dates below messages indicate under each bubble the send
date and hour of the message.

● Display read indicators below messages allows you to see if your message
has been read by your interlocutor. You can define an inactivity delay.

● Remove branding supprime la mention “powered by Ideta” en bas de

votre chatbot.
● You can choose the conversation layout (normal, medium, tall) as well as bubbles
maximum size.
● You can choose your send button appearance but also its text.

39
 2021

It is possible to assign a value to a data key by adding it to the bot URL.

Example:

If you access the bot by URL:

https://app.ideta.io/web-display/-LU0UvTNidkVmaBcV?param1=tanuki

The “param1” data key for this conversation will have the value "tanuki" (see the chapter on data)

Script Integration
There are features that allow you to manage the Livechat bubble’s appearance.

● ideta_bot_action(“load”) : charge the bot

ideta_bot_action(“load”, load_open?:boolean) is a function that accepts a second optional

parameter, which is boolean type (true / false) and allows to charge the already opened bot or
not.

● ideta_bot_action(“remove”) : remove the bot

● ideta_bot_action(“hide”) : hide the bot (only if it’s already charged)
● ideta_bot_action(“show”) : reveal the bot (only if it’s already charged and hidden)

NB: It is recommended to use these functions via window[“ideta_bot_action”](action) in order to

avoid any problems with code editors.

40
 2021

8. Configuring an API call

The purpose of this documentation is to present the form for configuring API calls, and to help
configure them.

In general, IDETA recommends that you always test your API calls in the Sandbox before
deploying on a channel, to ensure the validity of the configuration.

Request configuration

Authentication key

In the “request headers” part, it is possible to enter the header of its choice.

If the API authentication method called differs from the one proposed above, please contact
support.

*API’s URL (Required)

The URL of the targeted API.

You have the option of formatting your url with dynamic values ​from conversation data.

Example:

Warning! To be valid, the URL must be entered without spaces.

*Type of request (Required)

For the type of request, you should send, you can refer to the documentation of the targeted API.
The most common types of requests are ‘GET’ for data retrieval and ‘POST’ for sending.

41
 2021

Request content

During a ‘POST’, ‘PUT’ or ‘PATCH' request, you can attach a body to your request, including the
data you want to send. As with the URL, this data can come from the conversation.

Requests are in TEXT, JSON (Javascript Object Notation) or XML format. JSON format requires
the respect of the following syntax standards:

● The body of the request begins with ‘{‘and ends with ‘}’.
Each property name and value is enclosed in double quotes.
Example -> “property”
● Properties and values are separated by a colon.
Example -> “name”:”famine”
● each “property” set :”value 1” is separated from the next by a comma.
Example -> “property1”:”value1”,”property2”:”value2”

Example of a valid content:

Switching bubbles

Once the request has been made, the Following bubble allows you to redirect to the rest of the
conversation.

If an error occurs during the process (API not available, authentication error, error storing the
response ...), the Rescue bubble allows you to redirect to a suitable speech bubble to inform the
user.

*Max duration (required)

Maximum waiting time after which the conversation is automatically redirected to the Rescue
Bubble.

● The value to enter is an integer expressed in milliseconds.

● The recommended value is 2000 ms (2 seconds).

● The maximum authorized value is 10,000 ms (10 seconds)

● If the maximum duration is not enough, it is possible to use background actions.

42
 2021

Using bot with API

It is possible to achieve various actions on the bot using our API:

- Display the list of conversations
- Display conversations content
- Restart a conversation (or reset it)
- Delete or create/edit data
- Send a textual message
- Activate the display of a bubble

Firstly you have to get a secret key (available in the bot options). This key is unique and allows
access remotely the bot content.

You also have to get your bot ID.

It is in the URL bar of your browser when you are in the Ideta app:

Here the bot ID is -MKjQYL43Op0H94Pr29U

43
 2021

Display the conversations list

To get a list of posts: the request URL will be changed to

https://api.ideta.io/cockpit/conversations?<options> where the options can be one of the
following (options should be separated by “&”):
● channel=sandbox,web : only show conversations in the channels “sandbox” and “web”,
for example.
● startDate=2021-04-15 : only show conversations after and including this date.
● endDate=2021-04-16 : only show conversations before and including this date.
● conversation=v3aC53oI... : a specific conversation ID to show its messages also.
● comparisons=amount_eur,<,100;ideta_notify,.! : list of comparisons made in the filter.
They are separated by “;”.
● All above options are corresponding to the filtering options, which are given in the
“Cockpit” tab.

If there are several filters in the URL, only conversations satisfying all of these conditions are
returned.

A detailed example: below query gives a list of conversations which are in channels “sandbox”,
“web” and the last messages sent after “2021-04-02”.
https://api.ideta.io/cockpit/conversations?channel=sandbox,web&startDate=2021-04-02&compa
risons=amount_eur,<,100;ideta_notify,.!

To get a number of conversations: https://api.ideta.io/cockpit/count?<options> where

“<options>” has the same things as in the previous point.

Display the conversation content

Once these IDs are obtained, you can have a look at the conversation content.

You have to send a POST request towards the URL https://api.ideta.io/messages/extract/

{channel}.

The request content is:

{
"botId": "votre_id_de_bot",
"userId": "l_id_de_la_conversation",
"token": "670exemple_de_cle_secrete_f4r6t4t8s21"
}

Example of response:

{
"messages": {
44
 2021

"-MKjuhP_-e6t_jdpPcte": {
"node": {
"id": "typing",
"name": "Built-in bubble"
},
"sender": "bot",
"sent_at": "2020-10-28T15:54:22.814Z",
"template": {
"text": "...",
"type": "text"
},
"userId": "pPLoMHMAdhRZ22Amglx2"
},
"-MKjuhUloKcgUqB4xbRM": {
"node": {
"dataInput": {
"fallback": {
"active": false,
"options": {
"message": "",
"type": "go-to-node"
}
},
"nlp": {
"active": false,
"options": {
"service": "dialogflow",
"storage": {
"active": false
}
}
},
"saveData": {
"active": true,
"options": {
"dateOutput": "iso8601",
"key": "-MKjXO95dxnxjPUnnZBA",
"targetNode": "-MKjXPSxqAWJOmg06lHM"
}
},
"triggers": {

45
 2021

"active": false
}
},
"id": "noeud_0",
"name": "Hello"
},
"sender": "bot",
"sent_at": "2020-10-28T15:54:23.145Z",
"template": {
"text": "Bienvenue sur le bot de test API",
"type": "text"
},
"userId": "pPLoMHMAdhRZ22Amglx2"
}
}
}

Restart a conversation:

You also can restart a conversation.

You have to send a POST request towards the URL :

https://api.ideta.io/conversations/resume/:channel

The request content is:

{
"botId": "votre_id_de_bot",
"userId": "l_id_de_la_conversation",
"token": "670exemple_de_cle_secrete_f4r6t4t8s21"
}

Reset a conversation:

You also can delete a conversation then restart it.

You have to send a POST request towards the URL https://api.ideta.io/conversations/reset

{channel}.

It is possible to choose to delete data and/or the conversation message.

For that, you have to put “true” or “false” for "deleteData" and "deleteMessages"
46
 2021

The request content is:

{
"botId": "votre_id_de_bot",
"channel" : "web",
"sender" : "l_id_de_la_conversation",
"deleteData" : true,
"deleteMessages" : true,
"resetNode" : "noeud_0",

"token": "670exemple_de_cle_secrete_f4r6t4t8s21"
}

Delete or create/edit data

You can add or modify bot data.

You have to send a POST request towards the URL https://api.ideta.io/data/store/{channel}.

It is possible to modify the value of a data.

If you indicate « true » in « bypassChecks », the date will be created if it does not exist.

The request content is:

{
"objectToStore": {
"nom_de_ la_data": "nouvelle_ valeur"
},
"botId": "votre_id_de_bot",
"channel" : "web",
"senderId" : "l_id_de_la_conversation",
"token": "670exemple_de_cle_secrete_f4r6t4t8s21",
"bypassChecks": false

Send a textual message

It is possible to send a textual message in a conversation.

47
 2021

You have to send a POST request towards the URL

https://api.ideta.io/conversations/send-message {channel}

The request content is:

{
"botId": "votre_id_de_bot",
"sender": {
"id": "l_id_de_la_conversation",
"alternativeId": "l_id_de_la_conversation"
},
"payload":{
"type": "text",
"text": "contenu du message"
},
"token":"670exemple_de_cle_secrete_f4r6t4t8s21"
}

Activate the display of a bubble

On peut également actionner l’affichage d’une bulle du bot.

You have to send a POST request towards the URL

https://api.ideta.io/conversations/send-message/ {channel}

The request content is:

{
"botId": "votre_id_de_bot",
"sender": {
"id": "l_id_de_la_conversation",
"alternativeId": "l_id_de_la_conversation"
},
"payload":{
"type": "node",
"id": "-id_de_la_bulle"
},
"token":"670exemple_de_cle_secrete_f4r6t4t8s21"
}

48
 2021

Storage and use of response data

If you want to retrieve data from the API response you can activate the Store response option to
access the rest of the form:

*Storage key (required)

It is the key on which the response data will be saved.

- It must contain properties under which the desired values ​will be saved.

- For each property of the storage key, you can describe the path to follow to access the
desired value, in the “Data structure”.

- It can be an object type key or a list of objects.

- The key must have one or more properties. It is not necessary to fill in all the properties, but
you must configure at least one to have valid storage.

- Paths must be entered without spaces.

Storage in an object

49
 2021

Example of API’s answer:

Assuming that we want to recover the values ​of “city” and “closure”, the storage key will be
configured like this:

The setting will be as follows:

NB: The properties of the key can be named differently from the properties referred to in the
response.

Use

50
 2021

Once the API call has been successfully made, you can use the stored data like any other key in
the following bubble settings.

Example in a text bubble:

Storage in a list
Example API response:

51
 2021

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 to the list
(required). This field indicates its position within the response.

The setting will be as follows:

52
 2021

Use

Storing a list after an API call can be useful for automatically generating quick-replies, carousels or
lists.

Example in a quick-reply:

53
 2021

9. Third party products

Create a zap to receive the data by email at the end of the bot
https://zapier.com/app/dashboard

- Connect Webhooks by Zapier to Gmail:

- Select Catch Hook as a trigger and Send Email as an action

- Copy the given Webhooks URL:

- On the platform, create a “sending” bubble to send data towards Zapier and paste the URL:

54
 2021

This bubble will be called at the end of the conversation.

Name, email and phone values registered earlier in the conversation will be sent towards Zapier..

- Come back on Zapier, then connect your Gmail account and press continue:

- Choose your recipient and define your text adding variables.

- Perform a test pressing Test Trigger

- Skip “Pick off a Child Key” step without filling anything.

- Click on Finish. Now you can activate the Zap.

55
 2021

Facebook ads

- Go to Facebook's ad manager:

https://www.facebook.com/business/tools/ads-manager

- Click on ad manager.

- Create a campaign, choose “message"as the campaign objective then create a set of ads.

- In this set, create an advertisement.

- Choose “Send Message” as Call-to-action:

Then “Advanced Setup” in Message Template:

56
 2021

- To link your chatbot, you have to enter your targetnode. For that, indicate in the JSON code,
at the “payload” line:

{\"targetNode\" : \"ID_bulle\"}

To find your bubble ID, it is located in the URL bar when you create your bubble in the platform:

57