Deleted

post https://example.com/EVENTS.VOUCHER.DELETED

EVENT: "EVENTS.VOUCHER.DELETED"
HTTP method: POST

The EVENTS.VOUCHER.DELETED event indicates that a voucher has been successfully deleted. It provides ą real-time notification of that the voucher has been removed.

This event is used in a webhook configured in Project settings in Voucherify dashboard.

📘
Webhook documentation
This page documents only the event. If you need more details about the webhook payload data that includes this event, go to Webhook v2024-01-01 page.

Example: voucher.deleted

{
  "voucher": {
    "id": "v_48SKO3XotBsaHBVGXIdgcGSb684cbyrO",
    "code": "SPRING-2024-Ke5",
    "gift": null,
    "type": "DISCOUNT_VOUCHER",
    "active": true,
    "assets": {
      "qr": {
        "id": "4eb4397e-74b7-4272-85ce-8009699bb216",
        "url": "{{voucher_qr_code.url}}"
      },
      "barcode": {
        "id": "abb5691b-92f7-413a-ad22-ca492ac9df8a",
        "url": "{{voucher_barcode.url}}"
      }
    },
    "object": "voucher",
    "publish": {
      "url": "/v1/vouchers/SPRING-2024-Ke5/publications?page=1&limit=10",
      "count": 1,
      "object": "list"
    },
    "campaign": "Spring Discounts",
    "category": "Star Platinum",
    "discount": {
      "type": "PERCENT",
      "effect": "APPLY_TO_ORDER",
      "percent_off": 10,
      "amount_limit": 3000,
      "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
    },
    "metadata": {
      "brand": "Adventure"
    },
    "holder_id": "cust_ufwK2qUNGDYxa1aji7XKzuHm",
    "categories": [
      {
        "id": "cat_0e156dab8f2e43873a",
        "name": "Star Platinum",
        "object": "category",
        "hierarchy": 10,
        "created_at": "2024-01-03T10:03:24.092Z"
      }
    ],
    "created_at": "2024-02-21T10:01:24.456Z",
    "redemption": {
      "url": "/v1/vouchers/SPRING-2024-Ke5/redemptions?page=1&limit=10",
      "object": "list",
      "quantity": 1,
      "redeemed_quantity": 0
    },
    "start_date": null,
    "updated_at": "2024-03-29T07:38:38.643Z",
    "campaign_id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "category_id": "cat_0e156dab8f2e43873a",
    "loyalty_card": null,
    "validity_hours": null,
    "additional_info": null,
    "expiration_date": null,
    "is_referral_code": false,
    "validity_timeframe": null,
    "validity_day_of_week": null
  },
  "campaign": {
    "id": "camp_iRMdcq07g9W4dOSRXuTovupi",
    "name": "Spring Discounts",
    "type": "AUTO_UPDATE",
    "active": true,
    "object": "campaign",
    "voucher": {
      "gift": null,
      "type": "DISCOUNT_VOUCHER",
      "discount": {
        "type": "PERCENT",
        "units": null,
        "effect": "APPLY_TO_ORDER",
        "percent_off": 10,
        "amount_limit": 3000,
        "percent_off_formula": "IF(ORDER_AMOUNT > 150;15;10)"
      },
      "redemption": {
        "quantity": 1,
        "redeemed_quantity": 0
      },
      "code_config": {
        "length": 3,
        "prefix": "SPRING-2024-",
        "charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
        "pattern": "###",
        "postfix": ""
      },
      "loyalty_card": null
    },
    "category": null,
    "metadata": {},
    "auto_join": false,
    "join_once": false,
    "created_at": "2024-02-21T10:01:24.102Z",
    "start_date": null,
    "updated_at": "2024-03-13T17:35:51.314Z",
    "category_id": "cat_0e156dab8f2e43873a",
    "description": "Spring 2024 big campaign",
    "campaign_type": "DISCOUNT_COUPONS",
    "expiration_date": null,
    "is_referral_code": false
  }
}

Response

Response body

object

voucher

object | null

Object representing a voucher.

string

Assigned by the Voucherify API, identifies the voucher.

code

string

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

campaign

string

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

campaign_id

string

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

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

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

updated_at

date-time

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

object

string

required

Defaults to category

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

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

type

string

Defines the type of the voucher.

GIFT_VOUCHER DISCOUNT_VOUCHER LOYALTY_CARD

discount

object

Contains information about discount.

gift

object

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

loyalty_card

object

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

start_date

date-time

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

expiration_date

date-time

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

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.

validity_day_of_week

array of integers

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

validity_day_of_week

validity_hours

object

Allows to create Happy Hours scenario.

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

additional_info

string

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

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.

Has additional fields

assets

object

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

is_referral_code

boolean | null

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

created_at

date-time

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

updated_at

date-time

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

holder_id

string

Unique customer ID of voucher owner.

validation_rules_assignments

object

List of Validation Rules Assignments

referrer_id

string

Unique identifier of the referrer assigned by Voucherify.

object

string

Defaults to voucher

The type of the object represented by JSON. Default is 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.

redemption

object

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

campaign

object | null

Simplified campaign data.

string

Campaign ID.

name

string

Campaign name.

campaign_type

string

Type of campaign.

type

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

AUTO_UPDATE STATIC STANDALONE

is_referral_code

boolean

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

voucher

object

Simplified campaign voucher data.

referral_program

object

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

auto_join

boolean

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

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.

active

boolean

Indicates whether the campaign is active.

category_id

string | null

The unique category ID that this campaign belongs to.

categories

array of objects

Contains details about the category.

categories

object

string

required

Unique category ID assigned by Voucherify.

name

string

required

Category name.

hierarchy

integer

required

Category hierarchy.

created_at

date-time

required

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

updated_at

date-time

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

object

string

required

Defaults to category

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

category

stacking_rules_type

string

The type of the stacking rule eligibility.

JOINT EXCLUSIVE

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.

Has additional fields

start_date

date-time

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

expiration_date

date-time

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

description

string

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

created_at

date-time

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

updated_at

date-time

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

object

string

Defaults to campaign

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

campaign

EVENT: "EVENTS.VOUCHER.DELETED"HTTP method: POST

📘Webhook documentation

Example: voucher.deleted

200Indicates that a voucher has been deleted.

EVENT: "EVENTS.VOUCHER.DELETED"
HTTP method: POST

📘
Webhook documentation