Webhook events
Every event you can subscribe to, with the exact name to put in a filter.
To receive an event, add its name to events when you create a filter, then subscribe the filter to your target. Use the names exactly as shown: names aren't validated, so a misspelled name is saved but never matches.
Each event's page lists its request headers, every body field and an example payload. For the setup steps, headers and retries, see About webhooks.
App partners receive these store events too: create a store subscription for each store that installed your app. The app event, App Disconnected (integrations.applications.disconnected.v3), is under App partners.
Review events
Review event bodies have no topic field. Read the event name from the X-Yotpo-Webhooks-Event-Type header.
| Event name | Page | Sent when |
|---|---|---|
review_create | Review Created | When a new review is created. |
review_updated | Review Updated | When a review is published or unpublished, or when a reviewer verifies their email. |
review_request.eligible.on_fulfillment | Review Request Eligible on Fulfillment | When an order becomes eligible for a review request after it is fulfilled. |
review_request.eligible.on_delivery | Review Request Eligible on Delivery | When an order becomes eligible for a review request after it is delivered. |
Loyalty events
| Event name | Page | Sent when |
|---|---|---|
swell/redemption/created | Coupon Earned | When a customer gets a coupon code, either by completing a campaign (for example a newsletter signup) or by redeeming points. |
loyalty/custom/reward/created | Custom Reward Redeemed | When a customer redeems points for a custom reward, or gets a custom reward for completing a campaign. |
swell/customer/birthday | Customer Birthday | On a customer's birthday. |
swell/birthday/captured | Customer Birthday Captured | When a customer sets their birthday on your storefront, or when it's updated in Yotpo Loyalty. |
swell/customer/anniversary | Customer Anniversary | On a customer's anniversary. |
swell/anniversary/captured | Customer Anniversary Captured | When a customer sets their anniversary on your storefront. |
loyalty/donation/created | Donation Created | When a customer redeems points for a donation to a nonprofit through the Shopping Gives integration. |
swell/account/created | Account Created | When a customer gets the reward for the New Member Reward earning rule. |
loyalty/opt_in | Loyalty Opt In | When a customer opts in to the loyalty program. |
loyalty/opt_out | Loyalty Opt Out | When a customer opts out of the loyalty program. |
swell/points/changed | Points Changed | Every time a customer's points balance changes. |
swell/points/earned | Points Earned | When a customer earns points. |
swell/points/reminder | Points Reminder | After a set number of days of inactivity, when the customer is close to earning a reward. |
loyalty/expiration/reminder | Points Expiration Reminder | When a customer's points are about to expire. |
swell/redemption_code/below_threshold | Redemption Below Threshold | When a Custom Coupon reward is running low on uploaded codes. |
swell/point_redemption/cancellation_request | Redemption Cancellation Request | When a customer asks to cancel a redemption and get their points back. |
swell/redemption/reminder | Redemption Reminder | After a set number of days of inactivity, when the customer has enough points for a reward. |
swell/referral/share | Referral Link Share | When a customer shares their referral link with friends. |
yotpo/referral/shared | Referral Link Share (2.0) | When a customer shares their referral link with friends (Shopify stores that joined after August 2024). |
swell/referral/share/reminder | Referral Share Reminder | When a referred friend hasn't made a purchase after a set number of days. |
loyalty/referral/product_share | Referral Product Share Link | When a customer shares a product referral link. |
loyalty/referral/product_share/reminder | Referral Product Share Reminder | When a referred friend hasn't made a purchase after a set number of days. |
swell/referral/completed | Referral Completed | When a customer refers a friend who meets your referral program's requirements. |
yotpo/referral/completed | Referral 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/earned | Tier Earned | When a customer meets the requirements for a new tier. |
swell/tier/lost | Tier Lost | When 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/changed | Tier Status Changed | When a customer gets closer to or farther from keeping their current tier or reaching the next one. |
yotpo/tier/expiration/reminder | Tier Expiration Reminder | 30, 14 and 7 days before a customer's tier expires, if they haven't met the requirements to keep it. |
loyalty/integrations/integration_disabled | CommerceCloud Integration Disabled | When the Salesforce Commerce Cloud integration is disabled because of authorization errors. |
Two events have a 2.0 version for Shopify stores that joined Yotpo Loyalty & Referrals after August 2024:yotpo/referral/sharedreplacesswell/referral/share, andyotpo/referral/completedreplacesswell/referral/completed. Stores that joined earlier get the original events.
Updated 12 days ago
Did this page help you?