Deleted

WEBHOOK EVENTS.VOUCHER.DELETED

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
  }
}

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.

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 voucher.deleted.

voucher · Voucher · object

Object representing a voucher.

Show child attributes

campaign · Simple Campaign · object

Simplified campaign data.

Show child attributes

Response

200

Webhook accepted