Redemption Below Threshold

Sent when a Custom Coupon reward is running low on uploaded codes: when the unused codes reach the reward's threshold, then half, a quarter and an eighth of it, and 0.

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

Set the threshold on the Custom Coupon in your Yotpo Loyalty admin.

postWebhookswell/redemption_code/below_threshold

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/redemption_code/below_threshold.

namestring

The display name of the event.

redemption_option_idinteger

The unique identifier of the redemption option that has hit the thresholds.

redemption_option_namestring

The reward name.

number_of_unused_codesinteger

The number of unused codes left in the redemption option.

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.