onLoyaltyRewardRedeemed
Purpose
Triggered when a customer redeems a loyalty reward. Use this hook to track reward redemptions and monitor program engagement.
When It Triggers
Customer redeems points for a reward
Reward is processed and given to customer
Parameters
data.source
number
Server ID
data.shopId
string
Unique shop identifier
data.shopName
string
Display name of the shop
data.customerIdentifier
string
Customer's identifier
data.customerName
string
Customer's name
data.rewardId
string
Reward identifier
data.rewardName
string
Reward display name
data.rewardType
string
Type of reward ('coupon', 'item', etc.)
data.rewardValue
any
Reward value (discount %, item name, etc.)
data.pointsCost
number
Points spent on this reward
data.previousPoints
number
Points before redemption
data.newPoints
number
Points after redemption
data.couponCode
string
Generated coupon code (if reward is coupon)
data.timestamp
number
Server timestamp
Example
Last updated