Tier Expiration Reminder

webhook

yotpo/tier/expiration/reminder

Sent when a customer is at risk of losing their tier: 30, 14 and 7 days before it expires, depending on your settings, and only if they haven't met the requirements to keep it. Each reminder is sent once.

To receive it, add yotpo/tier/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.

Payload

topic

string

The event name, yotpo/tier/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 email address of the customer whose tier is about to expire.

customer

object

The customer object, including current VIP tier details (vip_tier_name, vip_tier_ends_at).

vip_tier_expiration_date

date-time

The date and time when the customer's current VIP tier expires (ISO 8601).

vip_tier_expiration_reminder_days

integer

How many days remain before the tier expires (for example, 30, 14, or 7).

vip_stats

object

The customer's current progress toward tier requirements (points_earned, amount_spent_cents).

vip_stats_needed_maintain

object

How much more the customer needs to maintain their current tier (points_needed, amount_cents_needed).

next_vip_tier_name

string

The name of the next VIP tier above the customer's current tier.

vip_stats_needed_next

object

How much more the customer needs to reach the next tier. This object is optional and may be omitted from the payload.

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.