EVENTS.CAMPAIGN.UPDATED event indicates that an existing campaign was modified within Voucherify. This event provides the campaign definition after the update, ensuring that relevant systems are informed in real-time.
This event is used in a webhook configured in Project settings in Voucherify dashboard.
Body
Event data object schema for campaign.updated.
Object representing a campaign.
Show child attributes
Show child attributes
Unique campaign ID, assigned by Voucherify.
"camp_f7fBbQxUuTN7dI7tGOo5XMDA"
Campaign name.
Type of campaign.
LOYALTY_PROGRAM, GIFT_VOUCHERS, DISCOUNT_COUPONS, PROMOTION, REFERRAL_PROGRAM 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 If set to true, customers will be able to auto-join a loyalty campaign if any earning rule is fulfilled.
If 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.
Flag indicating whether the campaign is to use the voucher's metadata schema instead of the campaign metadata schema.
Timestamp representing the date and time when the campaign was created in ISO 8601 format.
"2021-12-01T08:00:50.038Z"
Indicates the status of the campaign creation.
DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING Indicates the status of the campaign's voucher generation.
DONE, IN_PROGRESS, FAILED, DRAFT, MODIFYING Indicates whether the resource can be deleted.
Unique category ID that this campaign belongs to.
"cat_0b688929a2476386a7"
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 The type of the object represented by JSON. This object stores information about the campaign.
An optional field to keep extra textual information about the campaign such as a campaign description and details.
Schema model for a campaign voucher.
Show child attributes
Show child attributes
Type of voucher.
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.
Flag indicating whether this voucher is a referral code; true for campaign type REFERRAL_PROGRAM.
Defines the voucher discount type and details.
- 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.
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.
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 <= 31Activation 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"
Set recurrent time periods when the campaign 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 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 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 voucher 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"
Indicates recurrent time periods when the campaign is valid.
Show child attributes
Show child attributes
Defines the intervening time between two time points in 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 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"
Defines the amount of time the campaign will be active in ISO 8601 format after publishing. For example, a campaign with a duration of P24D will be valid for a duration of 24 days.
Total number of unique vouchers in 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"
Indicates if the campaign is active.
The metadata object stores all custom attributes assigned to the campaign. A set of key/value pairs that you can attach to a campaign object. It can be useful for storing additional information about the campaign in a structured format.
Timestamp representing the date and time when the campaign was updated in ISO 8601 format.
"2022-09-20T09:18:19.623Z"
Unique category name.
Defines 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.
Defines the Loyalty Tiers Expiration.
Show child attributes
Show child attributes
Tier qualification.
BALANCE: Points balance is based on the customer's current points balance. Customers qualify for the tier if their points balance is in the points range of the tier.
POINTS_IN_PERIOD: A customer qualifies for the tier only if the sum of the accumulated points in a defined time interval reaches the tier threshold.
BALANCE, POINTS_IN_PERIOD Defines the conditions for the start date of the tier.
Show child attributes
Show child attributes
What triggers the tier to be valid for a customer.
IMMEDIATE: After reaching the minimum required points.
NEXT_PERIOD: When the next qualification period starts.
IMMEDIATE, NEXT_PERIOD Defines the conditions for the expiration date of a tier.
Show child attributes
Show child attributes
What triggers the tier to expire for a customer.
END_OF_PERIOD: Expire tier at the end of the period.
END_OF_NEXT_PERIOD: Expire tier at the end of the next period.
BALANCE_DROP: Tier expires when the points balance drops below the required range of the tier.
CUSTOM: Tier expires after a certain time period passes following the instance the points balance drops below the required range of the tier.
END_OF_PERIOD, END_OF_NEXT_PERIOD, BALANCE_DROP, CUSTOM Extend the expiration by adding extra months or days in ISO 8601 format. The tier will remain active even though it reaches its expiration time period. For example, a tier with a duration of P3M will be valid for an additional duration of 3 months and a tier with a duration of P1D will be valid for an additional duration of 1 day.
Defines the rounding mechanism for the tier expiration.
Show child attributes
Show child attributes
Describes a custom rounding for the expiration date.
MONTH, QUARTER, HALF_YEAR, YEAR, CUSTOM Describes a rounding strategy for the expiration date.
START, END Defines the type of unit of time in which the rounding period is counted.
MONTH Value for the unit of time that the rounding applies to. Units for this parameter are defined by the rounding.unit parameter.
0: January1: February2: March3: April4: May5: June6: July7: August8: September9: October10: November11: December
Customers qualify for the tier if they collected enough points in a given time period.
MONTH, QUARTER, HALF_YEAR, YEAR Promotion Tiers
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about promotion tiers in a dictionary.
Identifies the name of the attribute that contains the array of promotion tier objects.
Contains array of promotion tier objects.
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 Total number of promotion tiers.
As query results are always limited (by the limit parameter), the has_more flag indicates whether there are more records for given filter parameters. This lets you know if you are able to run another request (with a different page or a different start date filter) to get more records returned in the results.
List of Validation Rules Assignments
Show child attributes
Show child attributes
The type of the object represented by JSON. This object stores information about validation rules assignments.
list Identifies the name of the attribute that contains the array of validation rules assignments.
data Contains array of validation rules assignments.
Show child attributes
Show child attributes
The unique identifier for an assignment.
The unique identifier for a rule.
The unique identifier for a related object.
The type of a related object.
campaign, voucher, earning_rule The type of the object represented by JSON.
validation_rules_assignment The validation status of the assignment.
VALID, PARTIALLY_VALID, INVALID The list of omitted rules.
Timestamp representing the date and time when the object was created in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Timestamp representing the date and time when the object was last updated in the ISO 8601 format.
"2024-01-01T11:11:11.111Z"
Total number of validation rules assignments.
x >= 0Lists all assignments of the campaign to areas and stores if the Areas and Stores feature is enabled (Enterprise feature).
Show child attributes
Show child attributes
The type of the object represented by JSON. Default is list. This object stores information about campaign assignments to areas and stores
list Identifies the name of the attribute that contains the array of campaign assignments.
data Contains an array of campaign assignments.
Show child attributes
Show child attributes
Unique identifier of the campaign assignment.
"arsca_0ef5ee192117ae2416"
Unique identifier of the area to which the campaign is assigned.
"ar_0ea6cd7b781b8f857f"
Date and time when the assignment was made. The value is shown in the ISO 8601 format.
"2024-06-25T19:04:16.260Z"
The type of the object represented by JSON. This object stores information about the campaign assignment to areas or stores.
"area_store_campaign_assignment"
Determines if the campaign is assigned to all of the stores in the area.
Unique identifier of the store to which the campaign is assigned.
"ars_0ec347e2016bed85f4"
Total number of areas and stores to which the campaign is assigned.
Response
Webhook accepted
Was this page helpful?