Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Table of Contents
minLevel1
maxLevel6
outlinefalse
typelist
printablefalse

Event Name

Properties

Description

Properties

Property Description

Tab

Triggered when a section is in view and a section tab is highlighted.

section

The locale specific section name that is currently highlighted and in the user’s view. E.g: FLAME-GRILLED BURGERS.

menuType

It has the value set to Direct Menu Access to know what type of menu was shown to the users.

Modal Appearance

Triggered when the All Categories modal is shown on mobile.

ModalHeader

It has the value set to All Categories to identify the modal that is being shown.Upsell Displayed

  • currentScreen: /menu /cart

  • price: Price of the upsell

  • Service Mode: Pickup, Delivery

A user is displayed an upsell to their cart on the website/app.

Upsell Displayed event is fired for each upsell item . This event has the following attributes:

Code Block
{
  custom_event_type: 'other',
  custom_flags: {},
  event_name: 'Upsell Displayed',
  timestamp_unixtime_ms: 1720162050033,
  session_uuid: 'A057E17A-0D98-42E9-920E-8B9E42CE2666',
  session_start_unixtime_ms: 1720161959380,
  custom_attributes: {
    'Service Mode': 'Pickup',
    'Pickup Mode': 'Drive Thru',
    'Source Page': '/menu',
    chefRecommendationEngine2: 'SANITY',
    currentScreen: '/menu',
    deviceTime: '09:47:30',
    serviceMode: 'Pickup',
    pickupMode: 'Drive Thru',
    appBuild: 'dev',
    name: '6pc Doritos Tangy Cheese Chicken Fries',
    sanityId: 'item_75187',
    price: 0,
    'Customer ID': 'ad919a84-f55f-42e5-9846-4856818e3265',
    Locale: 'en-GB',
    Platform: 'Web',
    RBIEnv: 'dev',
  },
}


Upsell Added

  • currentScreen: /menu /cart

  • price: Price of the upsell

  • upsellItemPosition: 1 2 3 4 5 6

A user adds a specific upsell to their cart on the website/app.

When adding an Upsell item there are two events that get published.

1) an event of type commerce_event  with the following payload

Code Block
action: 'add_to_cart',
  products: [
    {
      id: 'item_2188',
      name: '6 Chilli Cheese Bites*',
      total_product_amount: 3.49,
      price: 3.49,
      quantity: 1,
      custom_attributes: {
        cartId: '716bb156-9bca-4c88-aa5e-5a2c4c12ef52',
        sublevelItems: '[]',
        isDonation: 'False',
        isExtra: 'False',
        'Item Level': 'Child',
        comboChild: 'False',
        L1: 'ANCILLARIES',
        L2: 'SIDES/SNACKS',
        L3: 'OTHER SIDES',
        L4: 'OTHER SIDES',
        L5: 'Chili Chs Bites 6 Pc',
      },
    },
  ],

2) The Upsell Added event with the following payload:

Code Block
... other properties,
  name: '6 Chilli Cheese Bites*',
  sanityId: 'item_2188',
  price: 3.49,
  upsellItemPosition: 1,

Upsell Removed

  • currentScreen: /menu /cart

  • price: Price of the upsell

  • upsellItemPosition: 1 2 3 4 5 6

A user removes a specific upsell from their cart on the website/app. Payload

Code Block
Id: 'item_2188',
  Name: '6 Chilli Cheese Bites*',
  Price: 3.49,
  'Source Page': '/menu',
  Locale: 'en-GB',
  Platform: 'Web',
  RBIEnv: 'dev',

Upsize Displayed

When the upsize drawer is displayed / when the user is given the option to upsize an item.

serviceMode
eligibleProducts
<user>
<global attributes>
<restaurant>

screen attribute; which it is either /menu or /cart

Upsize Selection

When the user either selects to upsize (from the upsize drawer) or not to upsize.

serviceMode
eligibleProducts
<user>
<global attributes>
<restaurant>