post https://example.com/EVENTS.VOUCHER.LOYALTY_CARD.POINTS_ADDED
EVENT: "EVENTS.VOUCHER.LOYALTY_CARD.POINTS_ADDED"
The EVENTS.VOUCHER.LOYALTY_CARD.POINTS_ADDED event indicates that loyalty points have been successfully added to a customer's loyalty card associated with a voucher. It informs about the accumulation of loyalty points.
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.loyalty card.points added
{
"voucher": {
"id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
"code": "MBOpskws",
"loyalty_card": {
"points": 1370,
"balance": 1020
},
"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-24T08:28:37.621033Z",
"redemption": {
"quantity": null,
"redeemed_quantity": 5,
"redeemed_points": 350
},
"object": "voucher"
},
"balance": {
"type": "loyalty_card",
"total": 1370,
"object": "balance",
"points": 50,
"balance": 1020,
"operation_type": "MANUAL",
"related_object": {
"id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw",
"type": "voucher"
}
},
"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"
},
"customer": {
"id": "cust_IdgAFZxYwwHctOk9pPuMu308",
"name": "Jack Webhook",
"email": null,
"source_id": "jck-wbhk",
"metadata": {
"region": "EMEA"
},
"object": "customer"
},
"transaction": {
"id": "vtx_0e30615d5ed9b7011b",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"type": "POINTS_ADDITION",
"details": null,
"created_at": "2024-01-24T08:28:37.621033Z"
}
}