Click

Events categorized under the click level will be used to track the way user is interacting with the storefront. For example, if a user adds a product to cart or logs in.

Add to cart

This event is generated to track add to cart events, indicating when a user has added anything to the cart. It provides essential information about the user and the product added to the cart.

Events
click/add_to_cart/engagement/v1
# This event is triggered when a user adds any item to the cart. It contains details associated with the user and the product being added to the cart.

click/add_to_cart/engagement/v1

This event is triggered when a user adds any item to the cart. It contains details associated with the user and the product being added to the cart.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload associated with the event
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

Order checkout

This event is generated to track order checkout events, indicating when a user is checking out an order. It provides essential information about the order and its contents.

Events
click/order_checkout/conversion/v1
# This event is emitted when a user proceeds to checkout an order.

click/order_checkout/conversion/v1

This event is emitted when a user proceeds to checkout an order.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload for the generated event
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

Order complete

This event is generated to track order completion events, indicating when a user order has been successfully completed. It provides detailed information about the completed order, including item details, shipment information, and user data.

Events
click/order_complete/conversion/v1
# This event is triggered when an order is completed by the user.

click/order_complete/conversion/v1

This event is triggered when an order is completed by the user.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload for the emitted event
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

Product view

This event is triggered when the user views a product within the storefront. It captures details such as product ID, category, price, and user information, providing valuable insights for analytical and marketing purposes.

Events
click/product_view/click/v1
# This event is triggered when a user views a product within the storefront.

click/product_view/click/v1

This event is triggered when a user views a product within the storefront.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
payload for the emitted event
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

Product wishlist add

This event is triggered when a user adds a product to their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.

Events
click/product_wishlist_add/engagement/v1
# This event is triggered when a user adds a product to their wishlist within the storefront.

click/product_wishlist_add/engagement/v1

This event is triggered when a user adds a product to their wishlist within the storefront.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

Product wishlist remove

This event is triggered when a user removes a product from their wishlist within the storefront. It captures details such as wishlist name, ID, product details, and user information, providing valuable insights for tracking user engagement and preferences.

Events
click/product_wishlist_remove/engagement/v1
# This event is triggered when a user removes a product from their wishlist within the storefront.

click/product_wishlist_remove/engagement/v1

This event is triggered when a user removes a product from their wishlist within the storefront.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload for the event emitted
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

Remove from cart

This event is triggered when a user removes a product from their shopping cart within the storefront. It captures details such as cart ID, product details, price, and user information, providing insights into user behavior and cart management.

Events
click/remove_from_cart/engagement/v1
# This event is triggered when a user removes a product from their shopping cart within the storefront.

click/remove_from_cart/engagement/v1

This event is triggered when a user removes a product from their shopping cart within the storefront.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload for the emitted event.
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

User login

This event is triggered when a user logs into the storefront. It captures details such as login method, user device, and timestamp, providing insights into user authentication and behavior.

Events
click/user_login/identity/v1
# This event is triggered when a user logs into the storefront.

click/user_login/identity/v1

This event is triggered when a user logs into the storefront.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload for the generated event
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...

User logout

This event is triggered when a user logs out of the storefront. It provides insights into user session management and behavior.

Events
click/user_logout/identity/v1
# This event is triggered when a user logs out of the storefront.

click/user_logout/identity/v1

This event is triggered when a user logs out of the storefront.

Payload
application_id
array|string
Required
Application ID(Sales Channel) for which this event is triggered
contains
array of string
Required
This array will have all the keys present at root level of 'payload' object
event
object
Required
Properties
payload
object
Required
Payload for the emitted event
Properties
Payload Schema JSON
Loading...
Payload Example
Loading...