Custom Reward Redeemed

webhook

loyalty/custom/reward/created

Sent when a customer redeems points for a custom reward, or gets a custom reward for completing a campaign.

To receive it, add loyalty/custom/reward/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.

Custom rewards have no coupon code, so redemption.reward_text is always Redeemed.

Payload

topic

string

The event name, loyalty/custom/reward/created.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

redemption

object

The redemption.

at_checkout

boolean

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

is_pos

boolean

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

redemption_option

object

The reward (redemption option).

redemption_option_id

integer

The reward (redemption option) ID.

redemption_option_name

string

The reward name.

string

The email address of the customer who redeemed points for a custom reward

customer

object

The customer.

published_at

date-time

When Yotpo sent the event.

Headers

X-Yotpo-Webhooks-Event-Type

string

required

The event name. Matches topic in the body.

X-Yotpo-Webhooks-Tenant-Type

string

required

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

X-Yotpo-Webhooks-Tenant-Id

string

required

The store ID (app_key) the event belongs to.

WebhookMessageId

string

required

A unique ID for the event.

WebhookMessageIdPerTarget

string

required

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

Response

200

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

Loading…