Redemption Cancellation Request

webhook

swell/point_redemption/cancellation_request

Sent when a customer asks to cancel a redemption and get their points back. The points are returned only after you approve the cancellation through the API.

To receive it, add swell/point_redemption/cancellation_request 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/point_redemption/cancellation_request.

name

string

The display name of the event.

website_url

string

Your store's website URL.

store_name

string

Your store's name.

point_redemption_id

string

The ID of the redemption the customer wants to cancel. Use it when you approve the cancellation.

reward_text

string

The coupon code from the redemption the customer wants to cancel.

customer

object

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.