post https://example.com/EVENTS.VOUCHER.UPDATED
EVENT: "EVENTS.VOUCHER.UPDATED"
HTTP method: POST
HTTP method: POST
The EVENTS.VOUCHER.UPDATED event indicates that a voucher's information or attributes have been successfully modified. It informs other systems or applications about the changes made to the voucher.
The
EVENTS.VOUCHER.UPDATEDwebhook is not sent when the vouchers are updated in bulk.
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_EORkAULfvUsDf45sLckrboPi7Yl4FdjH",
"code": "10-percent-item-3",
"campaign": "Percent Item Discount Campaign",
"campaign_id": "camp_ILAvZfVhlUDm46S4DDZD6Yrv",
"category": null,
"category_id": "cat_0e156dab8f2e43873a",
"categories": [],
"type": "DISCOUNT_VOUCHER",
"discount": {
"type": "PERCENT",
"amount_limit": 5000,
"aggregated_amount_limit": 10000,
"percent_off": 10,
"effect": "APPLY_TO_ITEMS"
},
"gift": null,
"loyalty_card": null,
"start_date": null,
"expiration_date": null,
"validity_timeframe": null,
"validity_day_of_week": null,
"active": true,
"additional_info": null,
"metadata": {},
"assets": {
"qr": {
"id": "2d6ad829-a502-4dc1-b251-1522979b7c70",
"url": "{{voucher_qr_code.url}}"
},
"barcode": {
"id": "9d02c9a7-da65-41d9-b915-877880c92a52",
"url": "{{voucher_barcode.url}}"
}
},
"is_referral_code": false,
"created_at": "2023-12-12T12:12:12.638000Z",
"updated_at": "2024-01-01T11:11:11.572692Z",
"redemption": {
"quantity": null,
"redeemed_quantity": 4,
"object": "list",
"url": "/v1/vouchers/10-percent-item-3/redemptions?page=1&limit=10"
},
"publish": {
"object": "list",
"count": 0,
"url": "/v1/vouchers/10-percent-item-3/publications?page=1&limit=10"
},
"object": "voucher"
},
"campaign": {
"id": "camp_ILAvZfVhlUDm46S4DDZD6Yrv",
"name": "Percent Item Discount Campaign",
"object": "campaign"
}
}