CTRLK

Shared components

Template events

|

View as Markdown

Template events are designed to help you get started quickly with common scenarios like e-commerce, on-demand delivery, banking, and insurance. Use these events to quickly start with prebuilt scenarios. To create your own events, see Custom events.

Template events provide ready-to-use event definitions for common use cases.

You can:

  • Search for template events - Find events using the search bar
  • View event details - See the event table with:
    • Event name - The display name of the template event
    • Event ID - The predefined identifier
    • Event properties - Predefined properties that you can extend

The following table shows the available template events and their properties.

Event nameEvent IDDescriptionEvent properties
Added To CartaddedToCartIndicates a cart addition of a given item made by a profileitemId (Text), amount (Number), price (Number)
Added To FavouritesaddedToFavouritesIndicates a bookmark of a given item made by a profileitemId (Text)
Item PurchaseditemPurchasedIndicates a purchase of a given item made by a profileitemId (Text), amount (Number), price (Number), profit (Number)
Item VieweditemViewedIndicates a detail view of a given item made by a profileitemId (Text), duration (Number)
Rating AddedratingAddedIndicates a rating of a given item made by a profileitemId (Text), rating (Number)
View Portion SetviewPortionSetIndicates a partial view of an item (e.g., video or article) by a profileitemId (Text), portion (Number), sessionId (Text)

For industry-specific event examples and naming conventions, see Events best practices.




Was this page helpful?