Data object
In the data object you can access information about the conversation. It's also possible to store your own information inside the object. The information persist during the lifetime of the conversation.
You can see the structure of the data object below.
{
"id": "5a51b8be-c152-4b3f-ba5a-6f8334d67b77",
"name": "state_1598357081970",
"component": "e_b87631d8-d02b-45f0-8155-416fe8004eaf",
"bot_id": "59466d41-73c4-468f-a4b3-cebc78b0d6f8",
"parameters": {},
"db": {},
"conversation": {
"current_page": "/dashboard/studio/scenarios",
"user_last_input": "Hello there 😀",
"browser": "chrome",
"os": "Mac OS",
"platform": "web",
"time_before_start": 0
},
"customer_info": {
"id": "15983570899700895c067",
"image": None,
"info": {
"first_name": "Inclined",
"last_name": "Kangaroo"
},
"createdAt": "2020-08-25T12:04:49.000Z",
"updatedAt": "2020-08-25T12:04:49.000Z",
"first_name": "Inclined",
"last_name": "Kangaroo"
},
"chatId": "1598357063.115.dcacfe3b-45f5-4460-8046-51c0a5114b8f"
}
The parameter object is empty by default but you can pass data into it when calling on the custom component. The property object will not be persisted during the conversation. It is only valid for the component that has been triggered.
Property | Description |
id | Scenario id from where the component was triggered |
name | State name from where the component was triggered |
component | Unique id of the component |
bot_id | Unique bot id |
parameters | Contains the parameters that was sent to the component at the same time it was triggered |
db | has information about stored entities and parameters. If you return something from a custom component it's stored here. |
conversation | Information about the conversation. Describred separately |
customer_info | Information about the conversation. Describred separately |
chatId | Unique id of the chat |
The conversation object contains information about the conversation
Property | Description |
current_page | Gets updated with the visitors current page. Can be used to trigger different scenarios based on page. |
user_last_input | The latest input or action from the visitor |
browser | Information about the visitors browser |
os | Information about the operating system that the visitor has |
platform | Information about which platform the visitor use. Can be mobile, web, messenger, slack |
time_before_start | Number of seconds before the vistor starts interacting with Ebbot |
The conversation object contains information about the conversation
Property | Description |
id | Unique id of the visitor |
image | Only applicable if using messenger as integration. Link to the profile picture |
info | Contains info about first and last name. Used together with messenger integration |
createdAt | Datetime when the user was created |
updateadAt | Datetime when teh user was updated |
first_name | First name of the visitor. Can be updated through a scenario or custom component |
last_name | Last name of the visitor. Can be updated through a scenario or custom component |
Last modified 2yr ago