post https://example.com/EVENTS.VOUCHER.PUBLISHED
EVENT: "EVENTS.VOUCHER.PUBLISHED"
HTTP method: POST
HTTP method: POST
The EVENTS.VOUCHER.PUBLISHED event indicates that a voucher has been successfully published to a customer. The webhook includes, among others, the following details:
- URLs to the voucher's assets, such as QR code and barcode images,
- Associated campaign and its type,
- Expiration date.
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.published
{
"customer": {
"id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"name": "Jack Webhook",
"email": null,
"source_id": "jck-wbhk",
"metadata": {
"region": "EMEA"
},
"object": "customer"
},
"campaign": {
"id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"name": "Loyalty programme",
"campaign_type": "LOYALTY_PROGRAM",
"type": "AUTO_UPDATE",
"is_referral_code": false,
"voucher": {
"type": "LOYALTY_CARD",
"loyalty_card": {
"points": 0
},
"redemption": {
"quantity": null,
"redeemed_quantity": 0
},
"code_config": {
"length": 8,
"prefix": "",
"charset": "0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ",
"pattern": "########",
"postfix": ""
}
},
"auto_join": true,
"join_once": true,
"active": true,
"category_id": null,
"created_at": "2024-01-18T15:18:38.577044Z",
"object": "campaign"
},
"publication": {
"id": "pub_mLP4jygSMXfVejD3T9DmpsvHYah0Nd0I",
"object": "publication",
"created_at": "2024-01-18T15:19:26.594000Z",
"customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"tracking_id": "jck-wbhk",
"metadata": {},
"channel": "Automation",
"source_id": null,
"result": "SUCCESS",
"customer": {
"id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"source_id": "jck-wbhk",
"name": "Jack Webhook",
"address": null,
"summary": null,
"loyalty": null,
"referrals": null,
"metadata": {
"region": "EMEA"
},
"object": "customer"
},
"vouchers_id": [
"v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw"
]
},
"voucher": {
"id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
"code": "MBOpskws",
"loyalty_card": {
"points": 0,
"balance": 0
},
"type": "LOYALTY_CARD",
"campaign": "Loyalty programme",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"is_referral_code": false,
"holder_id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"category_id": null,
"active": true,
"created_at": "2024-01-18T15:18:39.015000Z",
"updated_at": "2024-01-18T15:19:26.501570Z",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"redeemed_points": 0
},
"object": "voucher"
},
"created_at": "2024-01-18T15:19:26.595Z"
}