YOyotpo

Coupon Earned

Sent when a customer gets a coupon code, either by completing a campaign (for example a newsletter signup) or by redeeming points. Use it to email the coupon code to the customer.

To receive it, add swell/redemption/created to events when you create a filter, then create a store subscription for each store that installed your app. Yotpo sends the event to your target URL as a POST with this JSON body.

Not sent when the customer doesn't receive a code explicitly, for example when they redeem at checkout.

Choose Awarded or Redeemed in the examples on the right. Awarded coupons include perk, campaign_id and source.

postWebhookswell/redemption/created

Headers

X-Yotpo-Webhooks-Event-Typestring required

The event name. Matches topic in the body.

X-Yotpo-Webhooks-Tenant-Typestring required

The kind of account the event belongs to: store for store events.

X-Yotpo-Webhooks-Tenant-Idstring required

The store ID (app_key) the event belongs to.

WebhookMessageIdstring required

A unique ID for the event.

WebhookMessageIdPerTargetstring required

A unique ID for this delivery to this target. Use it to ignore duplicates.

Payload

topicstring

The event name, swell/redemption/created.

namestring

The display name of the event.

website_urlstring

Your store's website URL.

store_namestring

Your store's name.

at_checkoutboolean

true when points are deducted only when the coupon is used at checkout.

is_posboolean

true when the redemption was made at a point of sale.

redemption_option_idinteger

The reward (redemption option) ID.

redemption_option_namestring

The reward name.

emailstring

The email address of the customer who got the coupon.

campaign_idinteger nullable

The ID of the campaign that gave the coupon, or null. Only on awarded coupons.

sourcestring

Where the coupon came from, for example VIP. Only on awarded coupons.

published_atstring date-time

When Yotpo sent the event.

Response

Return any 2xx status quickly to acknowledge the event. Without one, Yotpo retries at least 10 times with exponential backoff.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.