EVENTS.CAMPAIGN.PROMOTION_TIER.DISABLED event indicates that the promotion tier was disabled.
This event is used in a webhook configured in Project settings in Voucherify dashboard.
Body
Event data object schema for campaign.promotion_tier.disabled.
Event data object schema for activities related to campaign promotion tiers.
Simplified campaign data.
Show child attributes
Show child attributes
Campaign ID.
Campaign name.
Type of campaign.
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 criteriaSTATIC: vouchers need to be manually publishedSTANDALONE: campaign for single vouchers
AUTO_UPDATE, STATIC, STANDALONE Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Simplified campaign voucher data.
Show child attributes
Show child attributes
Type of the voucher.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER Defines the redemption limits on vouchers.
Schema containing information about config used for voucher. Defines the code pattern (prefix, suffix, length, charset, etc).
Show child attributes
Show child attributes
Number of characters in a generated code (excluding prefix and postfix).
Characters that can appear in the code.
A text appended before the code.
A text appended after the code.
A pattern for codes where hashes (#) will be replaced with random characters. Overrides length.
The initial count.
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
Show child attributes
Defines the type of the voucher.
AMOUNT 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.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
Defines the voucher gift details. It will not be returned at all or it will return a null for LOYALTY_CARD.
Show child attributes
Show child attributes
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.
Available funds. Value is multiplied by 100 to precisely represent 2 decimal places. For example, $10 amount is written as 1000.
Defines how the credits are applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS 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
Show child attributes
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.
Defines the loyalty point expiration rule. This expiration rule applies when there are no expiration_rules defined for an earning rule.
Show child attributes
Show child attributes
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.
FIXED_DAY_OF_YEAR, MONTH Value of the period. Required for the period_type: MONTH.
Type of rounding of the expiration period. Optional for the period_type: MONTH.
END_OF_MONTH, END_OF_QUARTER, END_OF_HALF_YEAR, END_OF_YEAR, PARTICULAR_MONTH Value of rounding of the expiration period. Required for the rounding_type.
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.
1 <= x <= 12Determines the day of the month when the points expire. Required for the period_type: FIXED_DAY_OF_YEAR.
1 <= x <= 31Defines the referee reward and the way a referral is triggered. Context: REFERRAL_PROGRAM.
Show child attributes
Show child attributes
Defines how a referral is triggered.
redemption, custom_event Defines the referee reward.
Show child attributes
Show child attributes
Details of the resource from which the reward originates.
Show child attributes
Show child attributes
Unique identifier of the reward source.
"camp_kdxp3vf1clQ9CFs1jpqv3tZe"
Name of the reward source.
Type of resource represented by the source of the reward.
CAMPAIGN Type of reward.
DISCOUNT_VOUCHER, LOYALTY_CARD, GIFT_VOUCHER 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.
Indicates whether customers will be able to auto-join the campaign if any earning rule is fulfilled.
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.
Indicates whether the campaign is active.
The unique category ID that this campaign belongs to.
Unique category name.
Contains details about the category.
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE 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.
Activation timestamp defines when the campaign starts to be active in ISO 8601 format. Campaign is inactive before this date.
"2022-09-20T00:00:00.000Z"
Expiration timestamp defines when the campaign expires in ISO 8601 format. Campaign is inactive after this date.
"2022-09-30T00:00:00.000Z"
An optional field to keep extra textual information about the campaign such as a campaign description and details.
Timestamp representing the date and time when the campaign was created. The value is shown in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the campaign was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by JSON. This object stores information about the campaign.
campaign Object representing a promotion tier. Promotion tiers are always assigned to a campaign and cannot be used standalone.
Show child attributes
Show child attributes
Unique promotion tier ID.
"promo_63fYCt81Aw0h7lzyRkrGZh9p"
Timestamp representing the date and time when the promotion tier was created in the ISO 8601 format.
"2021-12-15T11:34:01.333Z"
Timestamp representing the date and time when the promotion tier was updated in the ISO 8601 format.
"2022-02-09T09:20:05.603Z"
Name of the promotion tier.
Text to be displayed to your customers on your website.
Contains details about the discount applied by the promotion tier.
Show child attributes
Show child attributes
Contains information about discount.
- Discount
- Discount
- Discount
- Discount
- Discount
Show child attributes
Show child attributes
Defines the type of the voucher.
AMOUNT 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.
Maximum discount amount per order.
Defines how the discount is applied to the customer's order.
APPLY_TO_ORDER, APPLY_TO_ITEMS, APPLY_TO_ITEMS_PROPORTIONALLY, APPLY_TO_ITEMS_PROPORTIONALLY_BY_QUANTITY, APPLY_TO_ITEMS_BY_QUANTITY Flag indicating whether the discount was calculated using a formula.
The metadata object stores all custom attributes assigned to the promotion tier. A set of key/value pairs that you can attach to a promotion tier object. It can be useful for storing additional information about the promotion tier in a structured format.
The promotions hierarchy defines the order in which the discounts from different tiers will be applied to a customer's order. If a customer qualifies for discounts from more than one tier, discounts will be applied in the order defined in the hierarchy.
Promotion unique ID.
Contains details about promotion tier's parent campaign.
Show child attributes
Show child attributes
Unique campaign ID.
Activation timestamp defines when the campaign starts to be active in the ISO 8601 format. Campaign is inactive before this date.
"2022-09-22T00:00:00.000Z"
Expiration timestamp defines when the campaign expires in the ISO 8601 format. Campaign is inactive after this date.
"2022-09-30T00:00:00.000Z"
Recurrent time periods when the campaign is valid. For example, valid for 1 hour every other day.
Show child attributes
Show child attributes
Defines the intervening time between two time points in the ISO 8601 format, expressed as a duration. For example, a campaign with an interval of P2D will be active every other day.
Defines the amount of time the campaign will be active in the ISO 8601 format. For example, a campaign with a duration of P1D will be valid for a duration of one day.
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Allows to create Happy Hours scenario.
Show child attributes
Show child attributes
Defines the reccuring period/s of time when the happy hour promotion will be active.
Show child attributes
Show child attributes
Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.
"14:00"
A flag indicating whether the campaign is active or not active. A campaign can be disabled even though it's within the active period defined by the start_date and expiration_date using the Disable Campaign endpoint.
trueindicates an active campaignfalseindicates an inactive campaign
Unique category ID that this campaign belongs to.
"cat_0b688929a2476386a6"
The type of the object represented by the campaign object. This object stores information about the campaign.
Promotion tier's parent campaign's unique ID.
A flag to toggle the promotion tier on or off. You can disable a promotion tier even though it's within the active period defined by the start_date and expiration_date.
trueindicates an active promotion tierfalseindicates an inactive promotion tier
Activation timestamp defines when the promotion tier starts to be active in the ISO 8601 format. Promotion tier is inactive before this date.
"2022-09-23T00:00:00.000Z"
Activation timestamp defines when the promotion tier expires in the ISO 8601 format. Promotion tier is inactive after this date.
"2022-09-26T00:00:00.000Z"
Set recurrent time periods when the promotion tier is valid. For example, valid for 1 hour every other day. start_date required when including the validity_timeframe.
Show child attributes
Show child attributes
Defines the intervening time between two time points in the ISO 8601 format, expressed as a duration. For example, a promotion tier with an interval of P2D will be active every other day.
Defines the amount of time the promotion tier will be active in the ISO 8601 format. For example, a promotion tier with a duration of P1D will be valid for a duration of one day.
Integer array corresponding to the particular days of the week in which the promotion tier is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
0, 1, 2, 3, 4, 5, 6 Allows to create Happy Hours scenario.
Show child attributes
Show child attributes
Defines the reccuring period/s of time when the happy hour promotion will be active.
Show child attributes
Show child attributes
Defines the starting hour for the happy hours promotion in HH:mm format. Happy hours are inactive before this time.
"12:00"
Integer array corresponding to the particular days of the week in which the campaign is valid.
0Sunday1Monday2Tuesday3Wednesday4Thursday5Friday6Saturday
Defines the ending hour for the happy hours promotion in HH:mm format. Happy hours are inactive after this time.
"14:00"
Contains statistics about promotion tier redemptions and orders.
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about the promotion tier.
Validation Rule Assignments List
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rule assignments.
Identifies the name of the JSON property that contains the array of validation rule assignments.
A dictionary that contains an array of validation rule assignments.
Show child attributes
Show child attributes
Validation rule assignment ID.
"asgm_74F7QZoYbUoljwQO"
Validation rule ID.
"val_4j7DCRm2IS59"
The resource ID to which the validation rule was assigned.
"v_JtWunK6jUo7X2qOFj0SyRHq4p9tgENlT"
The type of resource to which the validation rule was assigned.
voucher, campaign, earning_rule, reward_assignment, promotion_tier, distribution Timestamp representing the date and time when the validation rule assignment was created in the ISO 8601 format.
"2022-02-17T08:18:15.085Z"
The type of the object represented by the ID.
validation_rules_assignment Total number of validation rule assignments.
Promotion tier category ID.
"cat_0c9da30e7116ba6bba"
Show child attributes
Show child attributes
Unique category ID assigned by Voucherify.
Category name.
Category hierarchy.
Timestamp representing the date and time when the category was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the object represented by the JSON. This object stores information about the category.
category Timestamp representing the date and time when the category was updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
The type of the stacking rule eligibility.
JOINT, EXCLUSIVE Response
Webhook accepted
Was this page helpful?