Versions Compared

Key

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

Table of Contents

Offers List

Offers Page

...

Event

Properties

Note

Status

1

Page View

  • Name: Offers

  • Path: /rewards/offers

Status
colourGreen
titleAVAILABLE

2

Button

  • Name: Account

  • Path: /rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

3

Button

  • Name: Rewards

  • Path:/rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

4

Link

  • Name: Choose Your Location

  • Path:/rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

5

Tab

  • Name: All Offers

  • Path:/rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

6

Tab

  • Name: External Offers

  • Path:/rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

7

Tab

  • Name: Favorites

  • Path:/rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

8

Button

  • Name: Have a Promo Code?

  • Path:/rewards/offers

Status
colourRed
titleNOT AVAILABLE YET

9

List Item

  • Name: Offer Name

  • Engine ID: Offer Engine ID

  • Sanity ID: Offer Sanity ID

  • Service Mode: pickup , delivery

  • Path:/rewards/offers

  • Type: All Offer, External Offer,Favorited Offers

Event is triggered when user clicks

Status
colourRed
titleNOT AVAILABLE YET

Offer Detail Page

...

Event

Properties

Note

1

Page View

  • Name: Offer Detail

  • Path: /rewards/offers/offerID

  • offerID Offer link

Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d

2

Button

  • Name: Account

  • Path: /rewards/offers/offerID

3

Button

  • Name: Rewards

  • Path:/rewards/offers/offerID

4

Link

  • Name: Choose Your Location

  • Path:/rewards/offers/offerID

5

Button

  • Name: Favorite

  • Path:/rewards/offers/offerID

6

Button

  • Name: Mobile Order

  • Path:/rewards/offers/offerID

7

Button

  • Name: Redeem In-Store

  • Path:/rewards/offers/offerID

External Offer Detail Page

...

Event

Properties

Note

1

Page View

  • Name: External Offer Detail

  • Path: /rewards/offers/offerID

  • offerID External Offer link

Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d

2

Button

  • Name: Back

  • Path: /rewards/offers/offerID

3

Button

  • Name: Favorite

  • Path:/rewards/offers/offerID

4

Button

  • Name: Mobile Order

  • Path:/rewards/offers/offerID

The label button changes depending on the external offer partner.

5

Button

  • Name: Terms and Conditions

  • Path:/rewards/offers/offerID

External Offer Modal

...

Event

Properties

Note

1

Modal

  • Name: Access External Offer

  • Path: /rewards/offers/offerID

  • offerID External Offer link

Example: 7d9b4e42-0b74-45d8-b4fc-2c86d04b0f0d

2

Button

  • Name: Yes

  • Path: /rewards/offers/offerID

3

Button

  • Name: Not Now

  • Path:/rewards/offers/offerID

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

  • Type: Reward ID

Reward Detail Page

...

...

Page View

...

  • Name: Reward Detail

  • Path: /rewards/list

...

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

  • User propriety: Tier 1, Tier 2

...

Button

...

  • Name: Account

  • Path: /rewards

...

Button

...

  • Name: How it Works

  • Path:/rewards

...

Card

...

  • Name: Reward

  • Path: /rewards

  • Type: 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