post https://example.com/EVENTS.VOUCHER.DELETED
EVENT: "EVENTS.VOUCHER.DELETED"
HTTP method: POST
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.
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.updated
{
"voucher": {
"id": "v_SLmKIus1KXxx5N9qT1ZMVWOu2xk6JxJs",
"code": null,
"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/null/publications?page=1&limit=10",
"count": 0,
"object": "list"
},
"campaign": "Your-campaign-applicable-to",
"category": null,
"discount": {
"type": "PERCENT",
"effect": "APPLY_TO_ITEMS",
"percent_off": 5,
"amount_limit": 15000,
"aggregated_amount_limit": 30000
},
"metadata": {},
"categories": [],
"created_at": "2024-02-02T02:02:02.222Z",
"redemption": {
"url": null,
"object": "list",
"quantity": null,
"redeemed_quantity": 0
},
"start_date": "2024-02-17T00:00:00.000Z",
"updated_at": null,
"campaign_id": "camp_18NCNUkQIaXnqbHqhtQnt355",
"category_id": null,
"loyalty_card": null,
"additional_info": null,
"expiration_date": "2024-02-29T00:00:00.000Z",
"is_referral_code": false,
"validity_timeframe": null,
"validity_day_of_week": [
1,
0
]
},
"campaign": {
"id": "camp_18NCNUkQIaXnqbHqhtQnt355",
"name": "Your-campaign-applicable-to",
"type": "AUTO_UPDATE",
"active": true,
"object": "campaign",
"voucher": {
"gift": null,
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "PERCENT",
"units": null,
"effect": "APPLY_TO_ITEMS",
"percent_off": 5,
"amount_limit": 15000,
"aggregated_amount_limit": 30000
},
"redemption": {
"quantity": null,
"redeemed_quantity": 0
},
"code_config": {
"length": 1,
"prefix": "Your-applicable-",
"charset": "0123456789",
"pattern": "#",
"postfix": ""
},
"loyalty_card": null
},
"metadata": {},
"auto_join": false,
"join_once": false,
"created_at": "2024-02-02T02:02:02.222Z",
"category_id": null,
"campaign_type": "DISCOUNT_COUPONS",
"is_referral_code": false
}
}