Reward Redemptions Pending

The EVENTS.CUSTOMER.REWARD_REDEMPTIONS.PENDING event indicates that redemption of a reward is in progress. This event is used in a webhook configured in Project settings in Voucherify dashboard.

This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Introduction to webhooks page.

Body

application/json

Event data object schema for customer.reward_redemptions.

customer

Simple Customer · object

Simplified customer data.

Show child attributes

customer.id

string

Unique identifier of an existing customer. It is assigned by Voucherify.

customer.name

string

Customer's first and last name.

customer.email

string

Customer's email address.

customer.source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

customer.metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

holder

Simple Customer · object

Details about the redeemable holder.

Show child attributes

holder.id

string

Unique identifier of an existing customer. It is assigned by Voucherify.

holder.name

string

Customer's first and last name.

holder.email

string

Customer's email address.

holder.source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

holder.metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

holder.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

voucher

Simple Voucher · object

Simplified voucher data.

Show child attributes

voucher.code

string

required

Voucher code.

voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

voucher.created_at

string<date-time>

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Example:

"2021-12-22T10:13:06.487Z"

voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

voucher.gift

Gift · object

Gift object response.

Show child attributes

voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

voucher.gift.effect

enum<string>

Defines how the credits are applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

voucher.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

voucher.discount.amount_off_formula

string

voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

voucher.loyalty_card.points

integer

required

Total number of points added to the loyalty card over its lifespan.

voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

voucher.loyalty_card.next_expiration_date

string

The next closest date when the next set of points are due to expire.

voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

voucher.campaign

string

Campaign name.

voucher.campaign_id

string

Campaign unique ID.

voucher.is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

voucher.holder_id

string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

voucher.categories.name

string

required

Category name.

voucher.categories.hierarchy

integer

required

Category hierarchy.

voucher.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

voucher.categories.object

enum<string>

default:category

required

The type of the object represented by the JSON. This object stores information about the category.

Available options:

category

voucher.categories.updated_at

string<date-time>

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

voucher.active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

voucher.updated_at

string<date-time>

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

voucher.start_date

string<date-time>

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

Example:

"2021-12-01T00:00:00.000Z"

voucher.expiration_date

string<date-time>

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

Example:

"2021-12-31T00:00:00.000Z"

voucher.metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

campaign

Simple Campaign · object

Simplified campaign data.

Show child attributes

campaign.id

string

Campaign ID.

campaign.name

string

Campaign name.

campaign.campaign_type

string

Type of campaign.

campaign.type

enum<string>

Defines whether the campaign can be updated with new vouchers after campaign creation or if the campaign consists of standalone vouchers.

AUTO_UPDATE: the campaign is dynamic, i.e. vouchers will generate based on set criteria
STATIC: vouchers need to be manually published
STANDALONE: campaign for single vouchers

Available options:

AUTO_UPDATE,

STATIC,

STANDALONE

campaign.is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

campaign.voucher

Simple Campaign Voucher · object

Simplified campaign voucher data.

Show child attributes

campaign.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.voucher.redemption

object

required

Defines the redemption limits on vouchers.

Show child attributes

campaign.voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

campaign.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

campaign.voucher.code_config

Code Config Settings · object

required

Schema containing information about config used for voucher. Defines the code pattern (prefix, suffix, length, charset, etc).

Show child attributes

campaign.voucher.code_config.length

number

required

Number of characters in a generated code (excluding prefix and postfix).

campaign.voucher.code_config.charset

string

required

Characters that can appear in the code.

campaign.voucher.code_config.prefix

string

required

A text appended before the code.

campaign.voucher.code_config.postfix

string

required

A text appended after the code.

campaign.voucher.code_config.pattern

string

required

A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.

campaign.voucher.code_config.initial_count

integer

The initial count.

campaign.voucher.discount

Discount · object

Defines the voucher discount type and details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Discount
Discount
Discount
Discount
Discount

Show child attributes

campaign.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

campaign.voucher.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

campaign.voucher.discount.amount_off_formula

string

campaign.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

campaign.voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

campaign.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

campaign.voucher.gift

Gift · object

Defines the voucher gift details. It will not be returned at all or it will return a null for LOYALTY_CARD.

Show child attributes

campaign.voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

campaign.voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

campaign.voucher.gift.effect

enum<string>

Defines how the credits are applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

campaign.voucher.loyalty_card

Campaign Loyalty Card · object

Defines the voucher loyalty card details. It will not be returned at all or it will return a null for DISCOUNT_VOUCHER or GIFT_CARD.

Show child attributes

campaign.voucher.loyalty_card.points

integer

required

The initial number of points to assign to the loyalty card. This is the current loyalty card score i.e. the number of loyalty points on the card.

campaign.voucher.loyalty_card.expiration_rules

object

Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.

Show child attributes

campaign.voucher.loyalty_card.expiration_rules.period_type

enum<string>

required

Type of period. Can be set for MONTH or FIXED_DAY_OF_YEAR. MONTH requires the period_value field. FIXED_DAY_OF_YEAR requires the fixed_month and fixed_day fields.

Available options:

FIXED_DAY_OF_YEAR,

MONTH

campaign.voucher.loyalty_card.expiration_rules.period_value

integer

Value of the period. Required for the period_type: MONTH.

campaign.voucher.loyalty_card.expiration_rules.rounding_type

enum<string>

Type of rounding of the expiration period. Optional for the period_type: MONTH.

Available options:

END_OF_MONTH,

END_OF_QUARTER,

END_OF_HALF_YEAR,

END_OF_YEAR,

PARTICULAR_MONTH

campaign.voucher.loyalty_card.expiration_rules.rounding_value

integer

Value of rounding of the expiration period. Required for the rounding_type.

campaign.voucher.loyalty_card.expiration_rules.fixed_month

integer

Determines the month when the points expire; 1 is January, 2 is February, and so on. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 12

campaign.voucher.loyalty_card.expiration_rules.fixed_day

integer

Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.

Required range: 1 <= x <= 31

campaign.referral_program

Referral Program · object

Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.

Show child attributes

campaign.referral_program.conversion_event_type

enum<string>

Defines how a referral is triggered.

Available options:

redemption,

custom_event

campaign.referral_program.custom_event

object

Contains details about the custom event.

Show child attributes

campaign.referral_program.custom_event.id

string

Unique custom event ID.

Example:

"ms_Ll9enAm2BCN0M1s4VxWobLFM"

campaign.referral_program.custom_event.name

string

Custom event name.

campaign.referral_program.referee_reward

object

Defines the referee reward.

Show child attributes

Details of the resource from which the reward originates.

Show child attributes

Unique identifier of the reward source.

Example:

"camp_kdxp3vf1clQ9CFs1jpqv3tZe"

Name of the reward source.

Type of resource represented by the source of the reward.

Available options:

CAMPAIGN

campaign.referral_program.referee_reward.type

enum<string>

Type of reward.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

campaign.referral_program.referee_reward.amount

string

Define the number of points to add to a loyalty card or credits to the balance on a gift card. In case of the gift card, the value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 amount is written as 10000.

campaign.auto_join

boolean

Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.

campaign.join_once

boolean

If this value is set to true, customers will be able to join the campaign only once. It is always false for standalone voucher campaigns and it cannot be changed in them. It is always true for loyalty campaigns.

campaign.active

boolean

Indicates whether the campaign is active.

campaign.category_id

string | null

The unique category ID that this campaign belongs to.

campaign.category

string

Unique category name.

campaign.categories

Category · object[]

Contains details about the category.

Show child attributes

campaign.categories.id

string

required

Unique category ID assigned by Voucherify.

campaign.categories.name

string

required

Category name.

campaign.categories.hierarchy

integer

required

Category hierarchy.

campaign.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

campaign.categories.object

enum<string>

default:category

required

The type of the object represented by the JSON. This object stores information about the category.

Available options:

category

campaign.categories.updated_at

string<date-time>

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

campaign.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

campaign.metadata

object

A set of custom key/value pairs that you can attach to a campaign. The metadata object stores all custom attributes assigned to the campaign.

campaign.start_date

string<date-time>

Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.

Example:

"2022-09-20T00:00:00.000Z"

campaign.expiration_date

string<date-time>

Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.

Example:

"2022-09-30T00:00:00.000Z"

campaign.description

string

An optional field to keep extra textual information about the campaign such as a campaign description and details.

campaign.created_at

string<date-time>

Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

campaign.updated_at

string<date-time>

Timestamp representing the date and time when the campaign was updated in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

campaign.object

enum<string>

default:campaign

The type of the object represented by JSON. This object stores information about the campaign.

Available options:

campaign

reward_redemption

object

Details about the redemption of a reward

Show child attributes

reward_redemption.id

string

Unique identifier of the reward redemption.

reward_redemption.state

enum<string>

State of the reward redemption.

Available options:

COMPLETED,

CREATED,

PENDING,

ROLLEDBACK

reward_redemption.created_at

string<date-time>

Timestamp representing the date and time when the reward redemption was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward_redemption.updated_at

string<date-time>

Timestamp representing the date and time when the reward redemption was last updated in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward_redemption.voucher_id

string

Unique identifier of the voucher.

reward_redemption.campaign_id

string

Unique identifier of the campaign to which the redeemed reward belongs.

reward_redemption.customer_id

string

Unique identifier of the customer redeeming the reward.

reward_redemption.reward_assignment_id

string

Unique identifier of the reward assignment.

reward_redemption.source_id

string

Unique identifier of the source which triggered the event.

reward_redemption.source_type

string

Defines the source type of the reward redemption.

reward

Simple Redemption Reward Result · object

Simplified redemption reward result data

Show child attributes

reward.customer

Simple Customer · object

Simplified customer data.

Show child attributes

reward.customer.id

string

Unique identifier of an existing customer. It is assigned by Voucherify.

reward.customer.name

string

Customer's first and last name.

reward.customer.email

string

Customer's email address.

reward.customer.source_id

string

A unique identifier of the customer. It can be a customer ID or email from a CRM system, database, or a third-party service.

reward.customer.metadata

object

A set of custom key/value pairs that are attached to the customer. It stores all custom attributes assigned to the customer.

reward.customer.object

enum<string>

The type of the object represented by JSON.

Available options:

customer

reward.assignment_id

string

Unique reward assignment ID assigned by Voucherify.

reward.voucher

Simple Voucher · object

Defines the voucher reward.

Show child attributes

reward.voucher.code

string

required

Voucher code.

reward.voucher.type

enum<string>

required

Type of the voucher.

Available options:

DISCOUNT_VOUCHER,

LOYALTY_CARD,

GIFT_VOUCHER

reward.voucher.created_at

string<date-time>

required

Timestamp representing the date and time when the order was created in the ISO 8601 format.

Example:

"2021-12-22T10:13:06.487Z"

reward.voucher.object

enum<string>

default:voucher

required

The type of the object represented by JSON.

Available options:

voucher

reward.voucher.id

string

A unique identifier that represents the voucher assigned by Voucherify.

reward.voucher.gift

Gift · object

Gift object response.

Show child attributes

reward.voucher.gift.amount

number

required

Total gift card income over the lifetime of the card. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

reward.voucher.gift.balance

number

required

Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.

reward.voucher.gift.effect

enum<string>

Defines how the credits are applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

reward.voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

reward.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

reward.voucher.discount.amount_off

number

required

Amount taken off the subtotal of a price. Value is multiplied by 100 to precisely represent 2 decimal places. For example, a $10 discount is written as 1000.

reward.voucher.discount.amount_off_formula

string

reward.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

reward.voucher.discount.effect

enum<string>

Defines how the discount is applied to the customer's order.

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS,

APPLY_TO_ITEMS_PROPORTIONALLY,

APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY,

APPLY_TO_ITEMS_BY_QUANTITY

reward.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

reward.voucher.loyalty_card

Simple Loyalty Card · object

Defines the loyalty card details. Simplified loyalty card data.

Show child attributes

reward.voucher.loyalty_card.points

integer

required

Total number of points added to the loyalty card over its lifespan.

reward.voucher.loyalty_card.balance

integer

Points available for reward redemption. This is calculated as follows: balance = points - expired_points - subtracted_points - redemption.redeemed_points.

reward.voucher.loyalty_card.next_expiration_date

string

The next closest date when the next set of points are due to expire.

reward.voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

reward.voucher.loyalty_card.pending_points

integer

Shows the number of pending points that will be added to the loyalty card when they are activated automatically or manually.

reward.voucher.loyalty_card.expired_points

integer

Shows the total number of expired points over the lifetime of the loyalty card.

reward.voucher.loyalty_card.subtracted_points

integer

Shows the total number of subtracted points over the lifetime of the loyalty card.

reward.voucher.campaign

string

Campaign name.

reward.voucher.campaign_id

string

Campaign unique ID.

reward.voucher.is_referral_code

boolean

Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.

reward.voucher.holder_id

string

Unique customer identifier of the redeemable holder. It equals to the customer ID assigned by Voucherify.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

reward.voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

reward.voucher.category_id

string | null

Unique identifier of the category that this voucher belongs to.

Example:

"cat_0b6152ce12414820dc"

reward.voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

reward.voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

reward.voucher.categories.name

string

required

Category name.

reward.voucher.categories.hierarchy

integer

required

Category hierarchy.

reward.voucher.categories.created_at

string<date-time>

required

Timestamp representing the date and time when the category was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward.voucher.categories.object

enum<string>

default:category

required

The type of the object represented by the JSON. This object stores information about the category.

Available options:

category

reward.voucher.categories.updated_at

string<date-time>

Timestamp representing the date and time when the category was updated in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward.voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

reward.voucher.active

boolean

Shows whether the voucher is on or off. true indicates an active voucher and false indicates an inactive voucher.

reward.voucher.updated_at

string<date-time>

Timestamp representing the date and time when the order was created. The value is shown in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward.voucher.redemption

object

Defines the redemption limits on vouchers.

Show child attributes

reward.voucher.redemption.quantity

integer | null

required

How many times a voucher can be redeemed. A null value means unlimited.

reward.voucher.redemption.redeemed_quantity

integer

required

How many times a voucher has already been redeemed.

Example:

1

reward.voucher.start_date

string<date-time>

Activation timestamp defines when the code starts to be active in ISO 8601 format. Voucher is inactive before this date.

Example:

"2021-12-01T00:00:00.000Z"

reward.voucher.expiration_date

string<date-time>

Expiration timestamp defines when the code expires in ISO 8601 format. Voucher is inactive after this date.

Example:

"2021-12-31T00:00:00.000Z"

reward.voucher.metadata

object

A set of custom key/value pairs that you can attach to a voucher. The metadata object stores all custom attributes assigned to the voucher.

reward.product

Simple Product · object

Defines the product reward.

Show child attributes

reward.product.id

string

Unique product ID.

reward.product.source_id

string

Product source ID.

reward.product.name

string

Product name.

reward.sku

Simple SKU · object

Defines the SKU reward.

Show child attributes

reward.sku.id

string

Unique SKU ID.

reward.sku.source_id

string

SKU source id.

reward.sku.sku

string

SKU name.

reward.loyalty_tier_id

string

Unique loyalty tier ID assigned by Voucherify.

reward.id

string

Unique reward ID, assigned by Voucherify.

Example:

"rew_nIy4gHpQHle2c3pNMwuj7G6j"

reward.object

enum<string>

default:reward

The type of the object represented by the JSON. This object stores information about the reward.

Available options:

reward

reward.name

string

Reward name.

reward.created_at

string<date-time>

Timestamp representing the date and time when the reward was created in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward.updated_at

string<date-time> | null

Timestamp representing the date and time when the reward was updated. The value is shown in the ISO 8601 format.

Example:

"2024-01-01T11:11:11.111Z"

reward.parameters

Campaign · object

Defines how the reward is generated. These are parameters representing a Campaign reward. These can be in the form of discount coupons, gift card credits, or loyalty point credits.

Campaign
Pay with Points
Material

Show child attributes

reward.parameters.campaign

Discount Coupons · object

Objects stores information about the campaign related to the reward.

Discount Coupons
Gift Vouchers
Points on loyalty card

Show child attributes

reward.parameters.campaign.id

string

required

Unique identifier of the campaign assigned by Voucherify.

Example:

"camp_13BbZ0kQsNinhqsX3wUts2UP"

reward.parameters.campaign.type

enum<string>

default:DISCOUNT_COUPONS

required

Campaign type.

Available options:

DISCOUNT_COUPONS

reward.metadata

object

A set of custom key/value pairs that you can attach to a reward. The metadata object stores all custom attributes assigned to the reward.

reward.type

enum<string>

Reward type.

Available options:

CAMPAIGN,

COIN,

MATERIAL

reward_assignment

object

Details about the assignment of the reward to the customer.

Show child attributes

reward_assignment.id

string

Unique reward assignment ID, assigned by Voucherify.

Example:

"rewa_PbIRoMXpwe5QhobW4JKu0VjH"

reward_assignment.reward_id

string

Associated reward ID.

Example:

"rew_C7wS9eHFDN4CIbXI5PpLSkGY"

reward_assignment.created_at

string<date-time>

Timestamp representing the date and time when the reward assignment was created. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T14:49:22.586Z"

reward_assignment.updated_at

string<date-time> | null

Timestamp representing the date and time when the reward assignment was updated. The value is shown in the ISO 8601 format.

Example:

"2022-08-11T16:01:34.885Z"

reward_assignment.object

enum<string>

default:reward_assignment

The type of the object represented by the JSON. This object stores information about the reward assignment.

Available options:

reward_assignment

Related object ID to which the reward was assigned.

Example:

"camp_wciTvaOfYmAa3EmIIW3QpXXZ"

Related object type to which the reward was assigned.

Available options:

campaign

reward_assignment.parameters

object

Defines the cost of the reward

Show child attributes

reward_assignment.parameters.loyalty

object

required

Defines the equivalent points value of the reward.

Show child attributes

reward_assignment.parameters.loyalty.points

integer

The number of points required to redeem the reward.

source

object

Show child attributes

source.id

string

Unique identifier of the reward redemption.

source.type

string

Type of the source triggering the event.

balance

object

Balance changed by the event.

Show child attributes

balance.amount

integer

Response

Webhook accepted

Introduction

Endpoints

Events

Reward Redemptions Pending

Body

Response