post https://example.com/EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.POINTS_ADDED
EVENT: "EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.POINTS_ADDED"
HTTP method: POST
HTTP method: POST
The EVENTS.CUSTOMER.VOUCHER.LOYALTY_CARD.POINTS_ADDED event indicates that loyalty points have been successfully added to a customer's loyalty card. 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: customer.voucher.loyalty card.points added
{
"customer": {
"id": "cust_2p0TvCOvB25HWUrW9JFf4czJ",
"name": "Alex Doe",
"source_id": "4l3x-d03",
"metadata": {},
"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,
"category": null,
"metadata": {},
"start_date": null,
"expiration_date": null,
"description": null,
"created_at": "2024-01-18T15:18:38.577Z",
"updated_at": "2024-02-09T13:04:15.034Z",
"object": "campaign"
},
"voucher": {
"id": "v_mFlEY0ZESRsEyfY12vTvz1VPfVDirAjc",
"code": "NK5iReoi",
"loyalty_card": {
"points": 2641,
"balance": 2641
},
"type": "LOYALTY_CARD",
"campaign": "Loyalty programme",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"is_referral_code": false,
"holder_id": "cust_tPTOETl00z1mWL5CzWEEPkNX",
"category_id": null,
"active": true,
"created_at": "2024-02-14T08:12:21.643Z",
"updated_at": "2024-03-11T15:27:44.884Z",
"redemption": {
"quantity": null,
"redeemed_quantity": 0,
"redeemed_points": 0
},
"start_date": null,
"expiration_date": null,
"metadata": {},
"object": "voucher"
},
"balance": {
"type": "loyalty_card",
"total": 2641,
"object": "balance",
"points": 40,
"balance": 2641,
"related_object": {
"id": "v_mFlEY0ZESRsEyfY12vTvz1VPfVDirAjc",
"type": "voucher"
}
},
"transaction": {
"id": "vtx_0e6d44043e9e51d377",
"source_id": "dd-pnts-uion",
"voucher_id": "v_mFlEY0ZESRsEyfY12vTvz1VPfVDirAjc",
"campaign_id": "camp_AQZ1GLRlbGaC2dETd31VbJQ9",
"source": "voucherify-web-ui",
"reason": "Spring time",
"type": "POINTS_ADDITION",
"details": {
"balance": {
"type": "loyalty_card",
"total": 2641,
"object": "balance",
"points": 40,
"balance": 2641,
"related_object": {
"id": "v_mFlEY0ZESRsEyfY12vTvz1VPfVDirAjc",
"type": "voucher"
}
}
},
"related_transaction_id": null,
"created_at": "2024-03-11T15:27:44.884Z"
}
}