Redemption Reminder

webhook

swell/redemption/reminder

Sent after a set number of days of inactivity, when the customer has enough points for a reward. Use it to remind them.

To receive it, add swell/redemption/reminder to events when you create a filter, then subscribe the filter to your target. Yotpo sends the event to your target URL as a POST with this JSON body.

Sent once a day, at 5 pm UTC.

Payload

topic

string

The event name, swell/redemption/reminder.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

string

The email address of the customer who is qualified for a redemption.

customer

object

The customer.

redemption_option

object

An object describing the reward option available to 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.

X-Yotpo-Webhooks-Tenant-Id

string

required

Your store ID.

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.