Versions Compared

Key

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

...

Event Name

Description

Properties

Property Description

Quest Activated

When a Quest/Challenge is activated by an user

totalStepsCount

Total # of steps in the Quest

activatedOn

Quest has been activated

incentiveId

refers to the CONFIG Offer or Reward ID if the Quest is type OFFER or REWARD respectively.

configId

UID for the personalized quest that is created for each specific user that activates a quest

stepsCompletedCount

Total # of steps completed

incentiveType

Type of Incentive (Reward or Offer)

loyaltyId

Loyalty ID associated with the User

name

Name associated with the Quest

createdAt

When was the transaction created

questId

ID associated with the Quest

Quest Step Completed

When a step as part of a Quest/Challenge is completed by an user

activatedOn

Quest has been activated

loyaltyId

Loyalty ID associated with the User

totalStepsCount

Total # of steps in the Quest

incentiveType

Type of Incentive (Reward or Offer)

stepsCompletedCount

Total # of steps completed

name

Name associated with the Quest

questId

ID associated with the Quest

createdAt

When was the transaction created

Quest Completed

When a Quest/Challenge is completed by an user

*For Invitation Code on Signup, this event is triggered by New user (user that signed up with Invitation Code that was shared from existing app user)

benefitId

refers to the the ID generated when the quest is completed. This can be the ID of: a personalized Offer or Reward if the quest is of type  OFFER or REWARD a transaction generated to grant points, if the quest is of type BONUS_POINTS

loyaltyId

Loyalty ID associated with the User

incentiveType

Type of Incentive (Reward or Offer)

stepsCompletedCount

Total # of steps completed

completedAt

When was the quest completed

name

Name associated with the Quest

totalStepsCount

Total # of steps in the Quest

questId

ID associated with the Quest

createdAt

When was the transaction created

Buddy Benefited from Quest Completion

When a Quest/Challenge is completed by an user and the benefit is also unlocked for Buddy users

*For Invitation Code on Signup, this event is triggered by Existing user (user from the app that shared his/her Invitation Code with a friend)

existingUserLoyaltyId

Loyalty ID associated with the Quest Buddy User (did not complete Quest steps)

name

Object with information on existing user data

newUserLoyaltyId

Loyalty ID associated with main user that completed Quest Steps

questId

ID associated with the Quest

email

email of Quest Buddy user

rbiCognitoId

User ID of Quest Buddy user

Loyalty Tiers

Tip

The data about user’s Loyalty Tier will be saved under User Properties as Tier (e.g. if user is in Loyalty Tier 1, then user property Tier will be set to 1)

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