List of supported events
Event name | Fires when |
---|---|
oncehub.chatbot.loaded | Chatbot widget is first loaded, on page load. |
oncehub.chatbot.opened | Visitor clicks anywhere to interact with the chatbot. |
oncehub.chatbot.started | Visitor starts interacting with the chatbot. |
oncehub.chatbot.closed | Visitor closes the chatbot widget. |
oncehub.chatbot.button_clicked | Visitor clicks on a button during the chatbot conversation. |
Events payloads
oncehub.chatbot.loaded
oncehub.chatbot.loaded
Payload example:
{
"type": "oncehub.chatbot.loaded",
"payload": {
"bot_id": "BOT-1234",
"bot_name": "example bot"
}
}
oncehub.chatbot.opened
oncehub.chatbot.opened
Payload example:
{
"type": "oncehub.chatbot.opened",
"payload": {
"bot_id": "BOT-1234",
"bot_name": "example bot"
}
}
oncehub.chatbot.started
oncehub.chatbot.started
Payload example:
{
"type": "oncehub.chatbot.started",
"payload": {
"bot_id": "BOT-1234",
"bot_name": "example bot"
}
}
oncehub.chatbot.closed
oncehub.chatbot.closed
Payload example:
{
"type": "oncehub.chatbot.closed",
"payload": {
"bot_id": "BOT-1234",
"bot_name": "example bot"
}
}
oncehub.chatbot.button_clicked
oncehub.chatbot.button_clicked
Payload example:
{
"type": "oncehub.chatbot.button_clicked",
"payload": {
"bot_id": "BOT-1234",
"bot_name": "example bot",
"button_text": "confirm",
"interaction_label": "schedule"
}
}