Data available
Data availableHere is a full list of the events and data available for the AI Shopping Assistant.
Event name | When it’s fired | Event details |
|---|---|---|
aishoppingassistant.view | upon widget load | |
aishoppingassistant.externalTrigger | upon external trigger is interacted | |
aishoppingassistant.opened | upon widget opened | |
aishoppingassistant.1stMessageSent | upon the first message sent | |
aishoppingassistant.messageSent | upon the message sent | |
aishoppingassistant.productRecommended | upon product recommended | |
aishoppingassistant.productClick | upon product clicked in the recommendation | |
aishoppingassistant.addToCart | upon clicking the add to cart button | |
aishoppingassistant.restart | upon clicking restart button | |
aishoppingassistant.closed | upon widget closed |
Event detailsevent name: aishoppingassistant.view
This event is fired whenever the AI shopping assistant widget is loaded. It will fire each time the widget is viewed.
This event is fired whenever the AI shopping assistant widget is loaded. It will fire each time the widget is viewed.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
event name: aishoppingassistant.externalTrigger
This event is fired whenever an external trigger activates the AI shopping assistant widget. It will fire each time the external trigger is called.
This event is fired whenever an external trigger activates the AI shopping assistant widget. It will fire each time the external trigger is called.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
aishoppingassistant.message |
| message content |
aishoppingassistant.triggerType |
| external trigger type |
event name: aishoppingassistant.opened
This event is fired when the AI shopping assistant widget trigger is clicked and the chat window opens.
This event is fired when the AI shopping assistant widget trigger is clicked and the chat window opens.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
event name: aishoppingassistant.1stMessageSent
This event is fired when the first message from user is sent.
This event is fired when the first message from user is sent.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
aishoppingassistant.message |
| first message content |
aishoppingassistant.isSuggestedText | false | The message is coming from a suggested prompt |
event name: aishoppingassistant.messageSent
This event is fired when a message from user is sent.
This event is fired when a message from user is sent.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
aishoppingassistant.message |
| message content |
aishoppingassistant.isSuggestedText | false | The message is coming from a suggested prompt |
event name: aishoppingassistant.productsRecommended
This event is fired when the widget recommends products to the user.
This event is fired when the widget recommends products to the user.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
aishoppingassistant.message |
| the message that triggered the product recommendation |
aishoppingassistant.products(array) |
| all the products recommended by the AI shopping assistant |
event name: aishoppingassistant.productClick
This event is fired when one of the recommended products is clicked.
This event is fired when one of the recommended products is clicked.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
aishoppingassistant.productId |
| the SKU of the product clicked |
aishoppingassistant.productName |
| the name of the product clicked |
aishoppingassistant.productPrice |
| the price of the product clicked |
aishoppingassistant.productPosition |
| the position of the product ranked in the recommended products |
event name: aishoppingassistant.addToCart
This event is fired when the user adds one of the recommended products to the cart.
This event is fired when the user adds one of the recommended products to the cart.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
aishoppingassistant.productId |
| the SKU of the product added to the cart |
aishoppingassistant.productName |
| the name of the product added to the cart |
aishoppingassistant.productPrice |
| the price of the product added to the cart |
event name: aishoppingassistant.restart
This event is fired when a user restart the chat.
This event is fired when a user restart the chat.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |
event name: aishoppingassistant.closed
This event is fired when a user closed the chat window.
This event is fired when a user closed the chat window.
Data variable | example | Description |
|---|---|---|
aishoppingassistant.visitorId |
| the visitor’s device ID |
aishoppingassistant.sessionId |
| the visitor’s session ID |
aishoppingassistant.page |
| the page URL of the widget was loaded |