Points Expiration Reminder

webhook

loyalty/expiration/reminder

Sent when a customer's points are about to expire. Use it to remind them to use their points.

To receive it, add loyalty/expiration/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, loyalty/expiration/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 customer's email address.

customer

object

The customer.

loyalty_next_points_expire_on

date

The date the next batch of points expires.

loyalty_next_points_expire_amount

integer

The number of points in the next expiring batch.

days_to_point_expiration

integer

Days left before the points expire.

timestamp

integer

When the event happened.

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.