Publication Succeeded

The EVENTS.CUSTOMER.PUBLICATION.SUCCEEDED event indicates that a voucher code was successfully published to a customer. This event serves as a real-time notification mechanism and it can notify other systems or applications that a voucher was assigned. As a result, the systems can react by, for example, sending a notification about an assignment to a customer. This event is used in a webhook configured in Distributions 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.publication.succeeded

customer

Simple Customer · object

required

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

campaign

Simple Campaign · object

required

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

publication

Publications with Voucher · object

required

Publication with a voucher.

Show child attributes

publication.id

string

required

Unique identifier of the publication assigned by Voucherify.

Example:

"pub_BbjAXnmm8e0SIm3zG8qvvFCP0KuLywtp"

publication.object

enum<string>

default:publication

required

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

Available options:

publication

publication.created_at

string<date-time>

required

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

Example:

"2022-09-23T09:57:00.434Z"

publication.customer_id

string

required

Unique identifier of the customer receiving the publication.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

publication.metadata

object

required

The metadata object stores all custom attributes assigned to the publication.

Show child attributes

publication.metadata.source_type

string

required

Defines the type of the distribution source.

publication.metadata.source_id

string

required

Unique identifier of the distribution source.

publication.metadata.distribution_id

string

required

Unique identifier of the distribution.

publication.channel

string

required

How the publication was originated.

publication.source_id

string | null

required

Unique identifier of the merchant's publication if it is different from the Voucherify publication ID.

publication.customer

Customer With Summary Loyalty Referrals · object

required

Customer details with details about loyalty and referral programs.

Show child attributes

publication.customer.summary

Customer Summary · object

required

Show child attributes

publication.customer.summary.redemptions

Customer Summary Redemptions · object

required

Show child attributes

publication.customer.summary.redemptions.total_redeemed

integer

required

Total number of the redemptions made by the customer.

publication.customer.summary.redemptions.total_failed

integer

required

Total number of the redemptions that failed.

publication.customer.summary.redemptions.total_succeeded

integer

required

Total number of the redemptions that succeeded.

publication.customer.summary.redemptions.total_rolled_back

integer

required

Total number of the redemptions that were rolled back for the customer.

publication.customer.summary.redemptions.total_rollback_failed

integer

required

Total number of the redemption rollbacks that failed.

publication.customer.summary.redemptions.total_rollback_succeeded

integer

required

Total number of the redemption rollbacks that succeeded.

publication.customer.summary.redemptions.gift

object

required

Summary of gift card credits.

Show child attributes

publication.customer.summary.redemptions.gift.redeemed_amount

integer

default:0

required

Total amount of gift card credits redeemed by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.

publication.customer.summary.redemptions.gift.amount_to_go

integer

default:0

required

Remaining gift card balance across all gift cards. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.

publication.customer.summary.redemptions.loyalty_card

object

required

Summary of loyalty points.

Show child attributes

publication.customer.summary.redemptions.loyalty_card.redeemed_points

integer

required

Total number of the loyalty points redeemed by the customer.

publication.customer.summary.redemptions.loyalty_card.points_to_go

integer

required

Sum of the remaining available point balance across all loyalty cards.

publication.customer.summary.orders

Customer Summary Orders · object

required

Show child attributes

publication.customer.summary.orders.total_amount

integer

required

The total amount spent by the customer. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.

publication.customer.summary.orders.total_count

integer

required

Total number of orders made by the customer.

publication.customer.summary.orders.average_amount

integer

required

Average amount spent on orders. total_amount ÷ total_count. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.

publication.customer.summary.orders.last_order_amount

integer

required

Amount spent on last order. The value is multiplied by 100 to precisely represent 2 decimal places. For example 1000 cents for $10.00.

publication.customer.summary.orders.last_order_date

string<date-time>

Timestamp representing the date and time of the customer's last order in the ISO 8601 format.

Example:

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

publication.customer.loyalty

Customer Loyalty · object

required

Show child attributes

publication.customer.loyalty.points

integer

required

Customer's loyalty points.

publication.customer.loyalty.referred_customers

integer

required

Total number of customers referred by the customer.

publication.customer.loyalty.campaigns

object

required

Contains campaigns with details about point balances and how many customers were referred by the customer.

Show child attributes

publication.customer.loyalty.campaigns.{key}

Campaign Loyalty Card Details · object

Contains details about the point balances left on loyalty cards and the number of referred customers in each campaign.

Show child attributes

publication.customer.loyalty.campaigns.{key}.points

integer

Remaining point balance in campaign.

publication.customer.loyalty.campaigns.{key}.loyalty_tier

string

Customer's loyalty tier within the campaign.

Example:

"ltr_UJ5Q54Q0OvEhua87Qfv2Ki5x"

publication.customer.loyalty.campaigns.{key}.referred_customers

integer

Number of customers referred by the customer in the campaign.

publication.customer.referrals

Customer Referrals · object

required

Summary of customer's referrals, in this case, the customer being the referee, i.e. information about the source of referrals and number of times the customer was referred by other customers.

Show child attributes

publication.customer.referrals.total

integer

required

Total number of times this customer received a referral, i.e. was referred by another customer.

publication.customer.referrals.campaigns

Customer Referrals Campaigns Item · object[]

required

Contains an array of campaigns that served as the source of a referral for the customer.

Show child attributes

publication.customer.referrals.campaigns.campaign_id

string

required

Unique identifier of the campaign assigned by Voucherify.

Example:

"camp_rRsfatlwN7unSeUIJDCYedal"

publication.customer.referrals.campaigns.referrer_id

string

required

Unique referrer ID assigned by Voucherify. This is the customer ID of a customer that is referring this customer.

Example:

"cust_sehkNIi8Uq2qQuRqSr7xn4Zi"

Related object id

Example:

"r_0b9d4cc4aa164dd073"

Related object type, i.e. redemption.

publication.customer.referrals.campaigns.date

string<date-time>

required

Timestamp representing the date and time when the customer was referred in the ISO 8601 format.

Example:

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

publication.customer.object

enum<string>

default:customer

required

The type of the object represented by JSON.

Available options:

customer

publication.customer.name

string

Customer's first and last name.

publication.customer.description

string

An arbitrary string that you can attach to a customer object.

publication.customer.email

string

Customer's email address.

publication.customer.phone

string

Customer's phone number. This parameter is mandatory for sending out codes to customers via an SMS channel.

publication.customer.birthdate

string<date>

Customer's birthdate; format YYYY-MM-DD.

publication.customer.address

object

Customer's address.

Show child attributes

publication.customer.address.city

string

City

publication.customer.address.state

string

State

publication.customer.address.line_1

string

First line of address.

publication.customer.address.line_2

string

Second line of address.

publication.customer.address.country

string

Country.

publication.customer.address.postal_code

string

Postal code.

publication.customer.metadata

object

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

publication.customer.id

string

The ID of an existing customer that will be linked to the redemption in this request.

publication.customer.source_id

string

A unique identifier of the customer who validates a voucher.

publication.customer.system_metadata

object

Object used to store system metadata information.

publication.customer.created_at

string<date-time>

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

Example:

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

publication.customer.updated_at

string<date-time>

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

Example:

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

publication.customer.assets

object

Contains information about the customer's cockpit.

Show child attributes

publication.customer.assets.cockpit_url

string

Customer's cockpit URL address.

publication.vouchers_id

string[]

required

Contains the unique internal voucher ID that was assigned by Voucherify.

publication.voucher

Voucher · object

required

Defines the voucher reward.

Show child attributes

publication.voucher.id

string

Assigned by the Voucherify API, identifies the voucher.

Example:

"v_mkZN9v7vjYUadXnHrMza8W5c34fE5KiV"

publication.voucher.code

string

A code that identifies a voucher. Pattern can use all letters of the English alphabet, Arabic numerals, and special characters.

Example:

"WVPblOYX"

publication.voucher.campaign

string

A unique campaign name, identifies the voucher's parent campaign.

Example:

"Gift Card Campaign"

publication.voucher.campaign_id

string

Assigned by the Voucherify API, identifies the voucher's parent campaign.

Example:

"camp_FNYR4jhqZBM9xTptxDGgeNBV"

publication.voucher.category

string

Tag defining the category that this voucher belongs to. Useful when listing vouchers using the List Vouchers endpoint.

publication.voucher.category_id

string

Unique category ID assigned by Voucherify.

Example:

"cat_0bb343dee3cdb5ec0c"

publication.voucher.categories

Category · object[]

Contains details about the category.

Show child attributes

publication.voucher.categories.id

string

required

Unique category ID assigned by Voucherify.

publication.voucher.categories.name

string

required

Category name.

publication.voucher.categories.hierarchy

integer

required

Category hierarchy.

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

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

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

publication.voucher.categories.stacking_rules_type

enum<string>

The type of the stacking rule eligibility.

Available options:

JOINT,

EXCLUSIVE

publication.voucher.type

enum<string>

Defines the type of the voucher.

Available options:

GIFT_VOUCHER,

DISCOUNT_VOUCHER,

LOYALTY_CARD

publication.voucher.discount

Discount · object

Contains information about discount.

Discount
Discount
Discount
Discount
Discount

Show child attributes

publication.voucher.discount.type

enum<string>

default:AMOUNT

required

Defines the type of the voucher.

Available options:

AMOUNT

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

publication.voucher.discount.amount_off_formula

string

publication.voucher.discount.aggregated_amount_limit

integer

Maximum discount amount per order.

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

publication.voucher.discount.is_dynamic

boolean

Flag indicating whether the discount was calculated using a formula.

publication.voucher.gift

object

Object representing gift parameters. Child attributes are present only if type is GIFT_VOUCHER. Defaults to null.

Show child attributes

publication.voucher.gift.amount

integer

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

Example:

10000

publication.voucher.gift.balance

integer

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

Example:

500

publication.voucher.gift.effect

enum<string>

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

Available options:

APPLY_TO_ORDER,

APPLY_TO_ITEMS

publication.voucher.loyalty_card

object

Object representing loyalty card parameters. Child attributes are present only if type is LOYALTY_CARD. Defaults to null.

Show child attributes

publication.voucher.loyalty_card.points

integer

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

Example:

7000

publication.voucher.loyalty_card.balance

integer

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

Example:

6970

publication.voucher.loyalty_card.next_expiration_date

string<date>

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

Example:

"2023-05-30"

publication.voucher.loyalty_card.next_expiration_points

integer

The amount of points that are set to expire next.

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

publication.voucher.loyalty_card.expired_points

integer

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

publication.voucher.loyalty_card.subtracted_points

integer

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

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

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

publication.voucher.validity_timeframe

object

Set recurrent time periods when the voucher is valid. For example, valid for 1 hour every other day. start_date required when including the validity_timeframe.

Show child attributes

publication.voucher.validity_timeframe.interval

string

Defines the intervening time between two time points in ISO 8601 format, expressed as a duration. For example, a voucher with an interval of P2D will be active every other day.

Example:

"P2D"

publication.voucher.validity_timeframe.duration

string

Defines the amount of time the voucher will be active in ISO 8601 format. For example, a voucher with a duration of PT1H will be valid for a duration of one hour.

Example:

"PT1H"

publication.voucher.validity_day_of_week

enum<integer>[]

Integer array corresponding to the particular days of the week in which the voucher is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

Available options:

0,

1,

2,

3,

4,

5,

6

publication.voucher.validity_hours

Validity Hours · object

Allows to create Happy Hours scenario.

Show child attributes

publication.voucher.validity_hours.daily

Daily · object[]

Defines the reccuring period/s of time when the happy hour promotion will be active.

Show child attributes

publication.voucher.validity_hours.daily.start_time

string<time>

Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.

Example:

"12:00"

publication.voucher.validity_hours.daily.days_of_week

array

Integer array corresponding to the particular days of the week in which the campaign is valid.

0 Sunday
1 Monday
2 Tuesday
3 Wednesday
4 Thursday
5 Friday
6 Saturday

publication.voucher.validity_hours.daily.expiration_time

string<time>

Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.

Example:

"14:00"

publication.voucher.active

boolean | null

A flag to toggle the voucher on or off. You can disable a voucher even though it's within the active period defined by the start_date and expiration_date.

true indicates an active voucher
false indicates an inactive voucher

publication.voucher.additional_info

string

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

publication.voucher.metadata

object

The metadata object stores all custom attributes assigned to the code. A set of key/value pairs that you can attach to a voucher object. It can be useful for storing additional information about the voucher in a structured format.

publication.voucher.assets

Voucher Assets · object

Stores links to images of QR and barcode that correspond to an encrypted voucher code.

Show child attributes

publication.voucher.assets.qr

object

Stores Quick Response (QR) representation of encrypted code.

Show child attributes

publication.voucher.assets.qr.id

string

Encrypted voucher code ID.

Example:

"U2FsdGVkX19ucFhvVmBVpVYG5KoswTsjSIaqoKg5L9ie4BK+t4pp7U7oFzjGJzj9q/bmuMOj9mEFiVKDMIkSaruKedMvHbKoPX5Sg+BaZk5QwXMf8k/OzSlOEVybpwSq+AiqPoNtjeuqtIgkDyvT6Q=="

publication.voucher.assets.qr.url

string

URL to a QR code.

publication.voucher.assets.barcode

object

Stores barcode representation of encrypted code.

Show child attributes

publication.voucher.assets.barcode.id

string

Encrypted voucher code ID.

publication.voucher.assets.barcode.url

string

URL to a barcode.

publication.voucher.is_referral_code

boolean | null

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

publication.voucher.created_at

string<date-time>

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

Example:

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

publication.voucher.updated_at

string<date-time>

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

Example:

"2021-12-22T10:14:45.316Z"

publication.voucher.holder_id

string

Unique customer ID of voucher owner.

Example:

"cust_eWgXlBBiY6THFRJwX45Iakv4"

publication.voucher.validation_rules_assignments

Validation Rules Assignments List · object

List of Validation Rules Assignments

Show child attributes

publication.voucher.validation_rules_assignments.object

enum<string>

default:list

required

The type of the object represented by JSON. This object stores information about validation rules assignments.

Available options:

list

publication.voucher.validation_rules_assignments.data_ref

enum<string>

default:data

required

Identifies the name of the attribute that contains the array of validation rules assignments.

Available options:

data

publication.voucher.validation_rules_assignments.data

Business Validation Rule Assignment · object[]

required

Contains array of validation rules assignments.

Show child attributes

publication.voucher.validation_rules_assignments.data.id

string

required

The unique identifier for an assignment.

publication.voucher.validation_rules_assignments.data.rule_id

string

required

The unique identifier for a rule.

The unique identifier for a related object.

The type of a related object.

Available options:

campaign,

voucher,

earning_rule

publication.voucher.validation_rules_assignments.data.object

enum<string>

default:validation_rules_assignment

required

The type of the object represented by JSON.

Available options:

validation_rules_assignment

publication.voucher.validation_rules_assignments.data.validation_status

enum<string>

required

The validation status of the assignment.

Available options:

VALID,

PARTIALLY_VALID,

INVALID

publication.voucher.validation_rules_assignments.data.validation_omitted_rules

string[]

required

The list of omitted rules.

publication.voucher.validation_rules_assignments.data.created_at

string<date-time>

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

Example:

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

publication.voucher.validation_rules_assignments.data.updated_at

string<date-time>

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

Example:

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

publication.voucher.validation_rules_assignments.total

integer

required

Total number of validation rules assignments.

Required range: x >= 0

publication.voucher.referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

Example:

"cust_nM4jqPiaXUvQdVSA6vTRUnix"

publication.voucher.object

string

default:voucher

The type of the object represented by JSON. Default is voucher.

publication.voucher.publish

object

This object stores a summary of publish events: an events counter and an endpoint which can be called to return details of each event. A publication is required for loyalty cards and referral codes. This object gets updated whenever a voucher has been published. Publication means assigning a code to a particular customer.

Show child attributes

publication.voucher.publish.object

string

default:list

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

publication.voucher.publish.count

integer

Publication events counter.

Example:

0

publication.voucher.publish.url

string

The endpoint where this list of publications can be accessed using a GET method. /v1/vouchers/{voucher_code}/publications

Example:

"/v1/vouchers/WVPblOYX/publications?page=1&limit=10"

publication.voucher.redemption

object

Stores a summary of redemptions that have been applied to the voucher.

Show child attributes

publication.voucher.redemption.quantity

integer

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

publication.voucher.redemption.redeemed_quantity

integer

How many times a voucher has already been redeemed.

Example:

1

publication.voucher.redemption.redeemed_amount

integer

Total amount redeemed. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $100 balance is written as 10000.

Example:

100000

publication.voucher.redemption.redeemed_points

integer

Total loyalty points redeemed.

Example:

100000

publication.voucher.redemption.object

string

default:list

The type of the object represented is by default list. To get this list, you need to make a call to the endpoint returned in the url attribute.

publication.voucher.redemption.url

string

The endpoint where this list of redemptions can be accessed using a GET method. /v1/vouchers/{voucher_code}/redemptions

Example:

"/v1/vouchers/WVPblOYX/redemptions?page=1&limit=10"

publication.tracking_id

string

Customer's source_id.

publication.result

enum<string>

default:SUCCESS

Status of the publication attempt.

Available options:

SUCCESS

voucher

Simple Voucher · object

required

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.

Response

Webhook accepted

Introduction

Endpoints

Events

Publication Succeeded

Body

Response