Points Changed

webhook

swell/points/changed

Sent every time a customer's points balance changes, with the balance before and after. Use it to keep a points balance in another system in sync.

To receive it, add swell/points/changed 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, swell/points/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 point balance changed.

customer

object

The customer.

previous_balance

integer

The customer’s point balance before the change.

current_balance

integer

The customer’s point balance after the change.

difference

integer

The points added (positive) or removed (negative).

added_or_removed

string

Whether points were added or removed.

points_changed_reason

string

Why the balance changed: a campaign title, Points Expired, a manual adjustment description, Refund made, Import or Redemption Made.

timestamp

date-time

When the event happened.

related_order_ids

array of strings

The IDs of the orders related to the change, as your store sent them.

related_order_ids

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.

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.

Loading…