Versions Compared

Key

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

Offers

Event Name

Description

Properties

Property Description

Offer Selected

User clicked on an offer from the offers list and saw the offer description.

(warning) Replaces the deprecated Offer click event.

name

Offer name, e.g. “£4.99 CHICKEN or VEGAN ROYAL”

sanityId

Sanity ID of the offer

Offer Added to Order

User added a reward to their order cart. When redemptionMode is In-Store, this event is triggered when the user clicks on the “Use at restaurant“ button.

(warning) Replaces the deprecated Restaurant Offer selected event.

Same as Offer Selected

Same as Offer Selected

redemptionMode

Can be either In-Store or Online.

Offer Favorite Added

User clicked on the heart to favourite an offer.

Same as Offer Selected

Same as Offer Selected

storeId

ID of the currently selected store, if any.

Offer Favorite Removed

User clicked on the heart to un-favourite an offer.

Same as Offer Selected

Same as Offer Favorite Added

Rewards

Default Program

Rewards Page

...

...

Event

...

Properties

...

Page View

...

  • Name: Rewards

  • Path: /rewards

...

Button

...

  • Name: Account

  • Path: /rewards

...

Button

...

  • Name: Rewards

  • Path:/rewards

...

Card

...

  • Name: Reward

  • Path: /rewards

  • Attribute: Reward ID

Reward Detail Page

...

...

Page View

...

  • Name: Reward Detail

  • Path: /rewards/detail

...

Button

...

  • Name: Back

  • Path: /rewards/detail

...

Button

...

  • Name: Add to Mobile Order

  • Path:/rewards/detail

...

Button

...

  • Name: Redeem In Restaurant

  • Path: /rewards/detail

Loyalty Tiers Program

Rewards Page

...

...

Page View

...

  • Name: Rewards

  • Path: /rewards

  • Attribute: Tier 1, Tier 2

...

Button

...

  • Name: Account

  • Path: /rewards

...

Button

...

  • Name: How it Works

  • Path:/rewards

...

Card

...

  • Name: Reward

  • Path: /rewards

  • Attribute: Reward ID

Unlocked Loyalty Tiers Reward

...

...

Page View

...

  • Name: Reward Detail

  • Path: /rewards/detail

...

Button

...

  • Name: Back

  • Path: /rewards/detail

...

Button

...

  • Name: Add to Mobile Order

  • Path:/rewards/detail

...

Button

...

  • Name: Redeem In Restaurant

  • Path: /rewards/detail

Locked Loyalty Tiers Reward

...

1

Page View

  • Name: Reward Detail

  • Path: /rewards/detail

2

Button

  • Name: Back

  • Path: /rewards/detail

3

Button

  • Name: Order More to become a Superking

  • Path:/rewards/detail

Event Name

Description

Properties

Property Description

Reward Selected

User clicked on the reward from reward list and saw the reward description.

name

Reward name, e.g. “Bacon Double XL Cheese Meal“

sanityId

Sanity ID of the offer

Reward Added to Order

User added a reward to their order cart.

Same as Reward Selected

Same as Reward Selected

Triggered when an offer is selected.

name

The locale specific name of the offer clicked. e.g. "6 Chilli Cheese"

isLoyaltUser

True

sanityId

The Sanity ID of the offer clicked. e.g. "b0cde124-241b-4831-a191-26c269d31e2d"

engineId

The Loyalty Engine ID of the offer clicked. e.g. "d94bf6cc-1850-48fd-817c-934051423835"

redemptionMode

E.g. Online

pickupMode

E.g. Take Out

serviceMode

E.g. Pickup

Button Click - Add to Order (Mobile Order)

Triggered after the user adds an offer to Pick Up or Delivery.

name

Add to Mobile Order

currentScreen

E.g.: /rewards/offers/7d09b162-781d-4e74-9d2f-b0c212574b6b

Source Page

redeem/

Button Click - Redeem In Restaurant (In-Store)

Triggered after the user adds an offer to be redeemed in the restaurant.

name

Redeem In Restaurant

currentScreen

E.g.: /rewards/offers/7d09b162-781d-4e74-9d2f-b0c212574b6b

Source Page

redeem/

Button Click - Remove Offer applied to Mobile Order

Triggered when the user removes the offer from the Pick Up/Delivery order from the Offers List.

name

Remove

Offer Favorite Added

Triggered after the user favorited an offer.

name

The locale specific name of the offer clicked. e.g. "6 Chilli Cheese"

isLoyaltUser

True

sanityId

The Sanity ID of the offer clicked. e.g. "b0cde124-241b-4831-a191-26c269d31e2d"

engineId

The Loyalty Engine ID of the offer clicked. e.g. "d94bf6cc-1850-48fd-817c-934051423835"

pickupMode

E.g. Take Out

serviceMode

E.g. Pickup

Button Click - Select a Tab

Triggered when a section tab is clicked.

name

Favorites , All Offers