Redemption Below Threshold

webhook

swell/redemption_code/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 subscribe the filter to your target. 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.

Payload

topic

string

The event name, swell/redemption_code/below_threshold.

name

string

The display name of the event.

redemption_option

object

An object describing the redemption option that is running low on redemption codes.

redemption_option_id

integer

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

redemption_option_name

string

The reward name.

number_of_unused_codes

integer

The number of unused codes left in the redemption option.

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.