Introduction to Loyalty Events

Yotpo can publish Loyalty & Referrals events to a webhook URL or directly to one of our partner integrations. These events can be used to trigger transactional emails, supplement customer data in your CRM, or pretty much anything else you could imagine.

To subscribe to these events, see About Webhooks.

Available events

Add the event name to events when you create a filter. Each page lists the request headers, every body field and an example payload.

Event namePageSent when
swell/redemption/createdCoupon EarnedWhen a customer gets a coupon code, either by completing a campaign (for example a newsletter signup) or by redeeming points.
loyalty/custom/reward/createdCustom Reward RedeemedWhen a customer redeems points for a custom reward, or gets a custom reward for completing a campaign.
swell/customer/birthdayCustomer BirthdayOn a customer's birthday.
swell/birthday/capturedCustomer Birthday CapturedWhen a customer sets their birthday on your storefront, or when it's updated in Yotpo Loyalty.
swell/customer/anniversaryCustomer AnniversaryOn a customer's anniversary.
swell/anniversary/capturedCustomer Anniversary CapturedWhen a customer sets their anniversary on your storefront.
loyalty/donation/createdDonation CreatedWhen a customer redeems points for a donation to a nonprofit through the Shopping Gives integration.
swell/account/createdAccount CreatedWhen a customer gets the reward for the New Member Reward earning rule.
loyalty/opt_inLoyalty Opt InWhen a customer opts in to the loyalty program.
loyalty/opt_outLoyalty Opt OutWhen a customer opts out of the loyalty program.
swell/points/changedPoints ChangedEvery time a customer's points balance changes.
swell/points/earnedPoints EarnedWhen a customer earns points.
swell/points/reminderPoints ReminderAfter a set number of days of inactivity, when the customer is close to earning a reward.
loyalty/expiration/reminderPoints Expiration ReminderWhen a customer's points are about to expire.
swell/redemption_code/below_thresholdRedemption Below ThresholdWhen a Custom Coupon reward is running low on uploaded codes.
swell/point_redemption/cancellation_requestRedemption Cancellation RequestWhen a customer asks to cancel a redemption and get their points back.
swell/redemption/reminderRedemption ReminderAfter a set number of days of inactivity, when the customer has enough points for a reward.
swell/referral/shareReferral Link ShareWhen a customer shares their referral link with friends.
yotpo/referral/sharedReferral Link Share (2.0)When a customer shares their referral link with friends (Shopify stores that joined after August 2024).
swell/referral/share/reminderReferral Share ReminderWhen a referred friend hasn't made a purchase after a set number of days.
loyalty/referral/product_shareReferral Product Share LinkWhen a customer shares a product referral link.
loyalty/referral/product_share/reminderReferral Product Share ReminderWhen a referred friend hasn't made a purchase after a set number of days.
swell/referral/completedReferral CompletedWhen a customer refers a friend who meets your referral program's requirements.
yotpo/referral/completedReferral Completed (2.0)When a customer refers a friend who meets your referral program's requirements (Shopify stores that joined after August 2024).
swell/tier/earnedTier EarnedWhen a customer meets the requirements for a new tier.
swell/tier/lostTier LostWhen a customer no longer meets the requirements for their tier at the end of the period, or when they opt out of the loyalty program.
swell/tier/status/changedTier Status ChangedWhen a customer gets closer to or farther from keeping their current tier or reaching the next one.
yotpo/tier/expiration/reminderTier Expiration Reminder30, 14 and 7 days before a customer's tier expires, if they haven't met the requirements to keep it.
loyalty/integrations/integration_disabledCommerceCloud Integration DisabledWhen the Salesforce Commerce Cloud integration is disabled because of authorization errors.