YOyotpo

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 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.

postWebhookswell/point_redemption/cancellation_request

Headers

X-Yotpo-Webhooks-Event-Typestring required

The event name. Matches topic in the body.

X-Yotpo-Webhooks-Tenant-Typestring required

The kind of account the event belongs to: store for store events.

X-Yotpo-Webhooks-Tenant-Idstring required

The store ID (app_key) the event belongs to.

WebhookMessageIdstring required

A unique ID for the event.

WebhookMessageIdPerTargetstring required

A unique ID for this delivery to this target. Use it to ignore duplicates.

Payload

topicstring

The event name, swell/point_redemption/cancellation_request.

namestring

The display name of the event.

website_urlstring

Your store's website URL.

store_namestring

Your store's name.

point_redemption_idstring

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

reward_textstring

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

published_atstring date-time

When Yotpo sent the event.

Response

Return any 2xx status quickly to acknowledge the event. Without one, Yotpo retries at least 10 times with exponential backoff.

Changes

Webhooks have no change history: a webhook is keyed by its event name rather than a path and method, so no recorded change can name it.