Tier Status Changed

webhook

swell/tier/status/changed

Sent when a customer gets closer to or farther from keeping their current tier or reaching the next one.

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

Payload

topic

string

The event name, swell/tier/status/changed.

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 VIP status changed.

customer

object

The customer whose VIP status changed.

vip_stats

object

Object reflecting the customer's accumulations towards earning a tier: Points Earned; Amount Spent (in cents): this refers to the annual amount spent by the customer (a rolling year or calendar year, according to your settings); How many purchases the customer made; How many referrals were completed

vip_stats_needed_next

object

Object conveying how much is needed for the customer to obtain the next tier.

vip_stats_needed_maintain

object

Object conveying how much is needed for the customer to maintain their current tier.

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.