Page Comparison

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.

immediateExpiryTime(User Attribute)

The date that the user’s points is set to expired, YYYY-MM-DD

immediatePointsExpiring(User Attribute)

Number of points are set to expire when the date is due

Guest Loyalty User Created

This event will trigger when a "Guest" user is created in-store using a specific identifier type of LOYALTY_12_DIGIT_SWIPE_CARD.

createdAt

Time of creation of event

identifier

The unique identifier which can be:

• A 12-digit physical card code

• A 10-digit phone number

guestId

The UID for the Guest Loyalty user

creationStoreId

The store ID of where the guest user was created

identifierType

Identifier Type being used (i.e. LOYALTY_12_DIGIT_SWIPE_CARD)

Secondary Identifier Associated

This event will trigger when a secondary identifier is associated to a loyalty user account. This can include guest loyalty users linking to a loyalty account.

createdAt

Time of creation of event

identifier

The unique identifier which can be:

• A 12-digit physical card code

• A 10-digit phone number

identifierType

Identifier Type being used (i.e. LOYALTY_12_DIGIT_SWIPE_CARD)

guestUserCreatedDate

The date that the guest user was created 

loyaltyId

UID for Loyalty User

Secondary Identifier Unlinked

When a Secondary Identifier is unlinked from a loyalty user account.

identifierType

Identifier Type being used (i.e. LOYALTY_12_DIGIT_SWIPE_CARD)

createdAt

When was the transaction created

identifier

The unique identifier which can be:

• A 12-digit physical card code

• A 10-digit phone number

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

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

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

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.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

Loyalty Transaction Claimed In-store

Shorthand for Loyalty Transaction Claimed when channel is RESTAURANT.

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

Loyalty Transaction Claimed Online

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

Same as Loyalty Transaction Created

Same as Loyalty Transaction Created

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.

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

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