Versions Compared

Old Version 60

changes.mady.by.user Alejandro Hinojosa

Saved on

compared with

New Version Current

changes.mady.by.user de Foucault, Stan

Saved on

Key

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

Table of contents

Table of Contents
Info

Note: in addition to properties described in this page, events below also include common properties documented here: Attributes and properties

...

Note: some events are called out as shorthands. There are similar to other, broader events, but sent separately to make it easier to run quick and targeted Amplitude queries without the need for complex filters (e.g. to run a quick analysis on how many offers were redeemed in-store last month, use the Offer Redeemed In-Store event without needing to filter for anything else). The Loyalty Transaction Claimed event is the umbrella event that captures all Claimed Loyalty Transactions, so this can be used to filter by sanityId or any other reward/offer attribute if needed be.

Event Name

Description

Properties

Property Description

Offer Redeemed Confirmed

Triggered when an offer is redeemed.

this event is fired. It happens at the time of creating the transaction. When a Loyalty transaction with channel is created, this event is fired with the transaction information.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

payAtCounter

Note

Note: Only when the transaction is created and claimed in different POS/Kiosk vendor

The

Event Name

Description

Properties

Property Description

Loyalty User Created

When a Loyalty user is created. In markets where loyalty is enabled, this happens at the same time that a new user signs up.

initialPointsBalance

Points added to the account when creation (could be subject to campaigns that add points when account created)

Loyalty User Updated

Triggered every time that a user’s loyalty points are updated.

newPointsBalance

Number of points in the user’s loyalty account, after a transaction has been made.

Loyalty Transaction Created

Triggered when any type of a loyalty transaction is created, including orders and point expiration. For orders, this event is triggered when an order is initiated and the transaction is in a Pending state. At this stage, the transaction is not completed yet. It will only be marked as completed once the ordering flow completes successfully (see Loyalty Transaction Claimed below).

For example, this event would be fired when a customer logins with their Loyalty OTP code in the Kiosk successfully (even if the customer has not completed the purchase in the Kiosk yet).

bonusPointsEarned

Additional points earned via promotion.

brand

Brand, for example “BK”.

channel

Can have the following values:

  • RESTAURANT: orders made in-restaurant

  • WEB: orders made on the web app

  • APP: orders made on the iOS or Android apps

  • INITIAL_POINT_BALANCE: we have certain markets that want brand new users to have a balance (i.e. sign up and get 100 pts). The INITIAL_POINT_BALANCE channel tracks those

  • POINTS_EXPIRATION: when points expire

  • CAMPAIGN: campaign is for transactions done via Braze campaigns that brands have setup

  • SUPPORT: when loyalty points are awarded to the user via the Support tool

  • REMEDIATION: REMEDIATION is for scripts that we've had to run to fix user balances

  • UNSUBSCRIPTION: When the user unsubscribes from the loyalty program, this channel is used to deduct the user’s points balance before deleting it from the db.

createdAt

Date and time when the transaction was created

offers

Offers redeemed on this transaction, if any

offersSanityIds

Sanity ID's for each offer redeemed in this transaction, if any

Partner

The partner that requested the loyalty points assignment

pointsEarned

Base points earned

pointsUsed

Points used to redeem

posType

The type of POS from where this transaction was created. For example, NCR, SYCOM. TABLET corresponds specifically to the RBI tablet in use in some markets.

posSystem

Specific POS vendor name, for example: ncr, Acrelec, Xenial Encounter.

rbiOrderId

The associated RBI Order Id

fulfillmentType

The fulfillment channel for the transaction. Can have one of the following values:

  • POS

  • TAKEOUT

  • DRIVE_THRU

  • EAT_IN

  • DELIVERY

  • CURBSIDE

  • POINT_ASSIGNMENT

restaurantId

Restaurant ID related to a purchase

rewards

The rewards redeemed in this transaction

rewardsSanityIds

The Sanity ids for each reward in this transaction

shortId

Autogenerated code for easy lookup via support tool

Store Has Loyalty

MDM loyalty assignment

  • Feature flag: Differentiating Between Loyalty and Non-Loyalty Stores for In-Store Orders

storeId

MDM assigned store number

subTotal

The total for the order

systemWidePromotions

The promotions redeemed with this transaction

totalPoints

User's total loyalty points post transaction

transactionStatus

The current status of the transaction:

  • PENDING: this will. be the status for all loyalty transactions created during the ordering process

  • CLAIMED: for non-ordering operations e.g. points expiry

  • UNCLAIMED

  • VOID

Loyalty Transaction Claimed

When an order completes successfully, loyalty transactions that were previously in a Pending state change to Claimed and this event is triggered.

Note

Note: Online transaction Claimed scenario is not covered by this event.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

Loyalty Cart Data

Cart data of the order.

  • Required properties: price, productId and quantity.

  • Optional properties: couponId, incentivePlu, lineId, name, parentReferenceId, plu, productType, rootReferenceId and tax.

In-Store Loyalty Transaction Claimed

Shorthand for Loyalty Transaction Claimed when channel is RESTAURANT.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

payAtCounter

Note

Note: Only when the transaction is created and claimed in different POS/Kiosk vendor

The posSystem different vendors from when transaction was created to when it was finalized, e.g. Tillster-Toshiba

Loyalty Cart Data

Cart data of the order.

  • Required properties: price, productId and quantity.

  • Optional properties: couponId, incentivePlu, lineId, name, parentReferenceId, plu, productType, rootReferenceId and tax.

Online Loyalty Transaction Claimed

Shorthand for Loyalty Transaction Claimed when channel is APP or WEB.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

Loyalty Cart Data

Cart data of the order.

  • Required properties: price, productId and quantity.

  • Optional properties: couponId, incentivePlu, lineId, name, parentReferenceId, plu, productType, rootReferenceId and tax.

Loyalty Points Expiring

When the user points are about to expire, an event indicating the amount of points and the future expiration date is fired. Triggered on defined days away: 1, 3, 7, 30, 60.

Note

Note: This event is only for points Expiration By Inactivity, not for Expiration By Issue Date.

daysAway

Days away from expiration of points (e.g. 14)

pointsAtRisk

Amount of points that will expire by the moment the event is triggered (e.g. 250)

pointsExpiryDate

Date of the expiration of points (e.g. 10/5/2022)

Loyalty Points Expired

Triggered when user points have expired.

channel

See Loyalty Transaction Created / channel

pointsEarned

Base points earned

pointsUsed

Points used to redeem

shortId

Autogenerated code for easy lookup via support tool

id

Unique Identifier for points expiration event

subTotal

The total for the order

brand

Brand from which the points have expired (e.g. BK)

transactionStatus

See Loyalty Transaction Created / transactionStatus

pointsDeducted

Amounts getting expired for not being used

createdAt

Date and time when the event was triggered

Loyalty Transaction Voided

When an order is voided.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

payAtCounter

Note

Note: Only when the transaction is created and voided in different POS/Kiosk vendor

The posSystem different vendors from when transaction was created to when it was finalized, e.g. Tillster-Toshiba

Loyalty Transaction Deleted

When a transaction is deleted this event is fired indicating the total points the user has after the rollback. Only Transactions that are in Pending which were created through the OTP process can be deleted.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

Max Transaction Limit Reached

Triggered when the maximum transactions limit is reached for a given user. This is an optional configuration setting that sets a "cap" of how many daily transactions a given user can earn points towards.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

Offers

Max Points Earned Limit Reached

Triggered when the maximum earned points limit is reached for a given user. This is an optional configuration setting that sets a "cap" of how many points a given user can earn points in a certain period of time (currently, only configurable per year).

maxPointsLimitReached

The period of type used to calculate the max points earned (e.g. yearly)

Other attributes are the same as Loyalty Transaction Claimed

Same as Loyalty Transaction Claimed

Offers

Event Name

Description

Properties

Property Description

Offer Redeemed Confirmed

Triggered when an offer is redeemed.

this event is fired. It happens at the time of creating the transaction. When a Loyalty transaction with channel is created, this event is fired with the transaction information.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

payAtCounter

Note

Note: Only when the transaction is created and claimed in different POS/Kiosk vendor

The posSystem different vendors from when transaction was created to when it was finalized, e.g. Tillster-Toshiba

Offer Redeemed In-store

Shorthand for Offer Redeemed Confirmed where channel is RESTAURANT.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

payAtCounter

Note

Note: Only when the transaction is created and claimed in different POS/Kiosk vendor

The posSystem different vendors from when transaction was created to when it was finalized, e.g. Tillster-Toshiba

Offer Redeemed Online

Shorthand for Offer Redeemed Confirmed where channel is WEB or APP.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

...

Event Name

Description

Properties

Property Description

Loyalty Tier Updated

Triggered after a transaction when a user moves from a Loyalty Tier to another Loyalty Tier (e.g. user moves from Tier 1 to Tier 2 or user is downgraded from Tier 2 to Tier 1). When user signs up, we will not trigger this event from user having no tier to Tier 1 (this we can measure with the Sign Up Complete event).

Info

Note: The rules required for a user to enter Tier 2 and rules required for user to continue being a part of Tier 2 are set under Earning Calculation Folder in Sanity.

loyaltyTierChange

This property describes the Loyalty Tier changes the user has gone through. The two possible values for this property are:

  • Tier1-Tier2 - this means the user went from Loyalty Tier 1 (King Loyalty User) to Loyalty Tier 2 (Superking Loyalty user)

  • Tier2-Tier1 - this means the user was demoted from Loyalty Tier 2 (Superking Loyalty User) to Loyalty Tier 1 (King Loyalty user)

updatedTime

Time when user updated their tiers

pointBalance

Loyalty Point balance that the user has at this point

rbiCognitoId

User ID of user that updated loyalty tiers

Loading Events

Event Name

Description

Properties

Property Description

Loyalty Points Assignment

Triggered when the Loyalty Points Assignment endpoint receives a request from a partner.

Duration

The duration in ms of the loyalty points assignment process from the time the request is received until it is finished.

Partner

The partner that requested the loyalty points assignment.

pointsDeducted

How many points were deducted from the user.

pointsEarned

How many points the user earned.

Reference

An optional property where the partner can send the reason or event that generated the request for this loyalty points assignment.

Status

Successful or Error.

TransactionId

The id of the transaction created for the points assignment. (Only for the Successful status)

ErrorDescription

The error that happened. (Only for the Error status)

Event Name

Description

Properties

Property Description

Loyalty Load

Triggered after the page loads.

My Code page load timeMy_Code_page_load_time

This property describes the amount of time in milliseconds that the My Code page took to load.

My Code page QR code load timeMy_Code_page_QR_Code_load_time

This property describes the amount of time in milliseconds that the QR Code on the My Code page took to load and be visible.Rewards page load time

Rewards_page_load_time

This property describes the amount of time in milliseconds that the Rewards page took to load.

Offers page load timeOffers_page_load_time

This property describes the amount of time in milliseconds that the Offers page took to load.

Offer Redemption page load timeOffer_Redemption_page_load_time

This property describes the amount of time in milliseconds that the Offer Redemption modal page for static code took to load.

Offer Redemption page QR Code load timeOffer_Redemption_page_QR_Code_load_time

This property describes the amount of time in milliseconds that the Offer Redemption modal QR Code took to load. This will only be sent if QR Code is enabled.

Offer Redemption page Short Code load timeOffer_Redemption_page_Short_Code_load_time

This property describes the amount of time in milliseconds that the Offer Redemption modal offer short code took to load.

QR and Short code Error

Triggered when the QR and Short code cannot be generated.

Message

This property refers to a string in Lokalise (qrCodeLoyaltyCreationError), informing that there is an error when creating the QR and Short code.

rootCause

This property refers to the root cause why the QR Code cannot be generated

isNetworkError

This property refers to whether the error is generated by a network error

Points

isNetworkError

This property refers to whether the error is generated by a network error

Points

Event Name

Description

Properties

Property Description

Loyalty Points Assignment

Triggered when the Loyalty Points Assignment endpoint receives a request from a partner.

Duration

The duration in ms of the loyalty points assignment process from the time the request is received until it is finished.

Partner

The partner that requested the loyalty points assignment.

pointsDeducted

How many points were deducted from the user.

pointsEarned

How many points the user earned.

Reference

An optional property where the partner can send the reason or event that generated the request for this loyalty points assignment.

Status

Successful or Error.

TransactionId

The id of the transaction created for the points assignment. (Only for the Successful status)

ErrorDescription

The error that happened. (Only for the Error status)

Promo Codes

Event

Fires when

Main attributes

Payload details

Action Sheet View

When a Action tab it`s displayed to the user

Image Added

actionSheetHeader record the component/object name (i.e. “Apply Promo Code”)

currentScreen records the current screen where the Action tab it`s displayed (i.e. “/rewards/offers“)

Image Added

Action Sheet Submission

When a Action form it`s submitted

Image Added

response: records the response "Failed" or “successful“

failureReason reason why the response was failed main reasons it`s "INVALID_CODE" or “EXPIRED_CODE“

submittedData records the data sent in the Action form

Image Added

Promo Code Applied

When the Promo Code endpoint in the Loyalty Engine is hit

  • Duration: The duration in ms of the offer being unlocked when a promo code is sent.

  • sanityId: The Sanity ID of the offer.

  • Partner: The “posSystem” of the vendor sending the request. If this request is from RBI to show promo code offer in the app, then partner would be “RBI”.

  • Status: Successful or Error.

  • traceId: The tracking_id sent by Voucherify.

  • ErrorDescription (Only for the Error status): The error that happened.

    • Error: “Promo Code” not found

    • Error: “Promo code” already used

    • Error: Failed to unlock offer due to a technical issue

To add when tested in Staging