Rewarded

EVENT: "EVENTS.CUSTOMER.REWARDED"
HTTP method: POST

The EVENTS.CUSTOMER.REWARDED event indicates that a customer received a reward in exchange for points in a loyalty campaign. The action is usually a manual process started by the customer.

This event is used in a webhook configured in Distributions in Voucherify dashboard.

📘

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.rewarded

{ "customer": { "id": "cust_IdgAFZxYwwHctOk9pPuMu308", "name": "Jack Webhook", "email": null, "source_id": "jck-wbhk", "metadata": { "region": "EMEA" }, "object": "customer" }, "holder": { "id": "cust_IdgAFZxYwwHctOk9pPuMu308", "name": "Jack Webhook", "email": null, "source_id": "jck-wbhk", "metadata": { "region": "EMEA" }, "object": "customer" }, "voucher": { "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw", "code": "L0y4L", "loyalty_card": { "points": 900, "balance": 850 }, "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:27:56.228461Z", "redemption": { "quantity": null, "redeemed_quantity": 1, "redeemed_points": 50 }, "object": "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" }, "redemption": { "id": "r_0e2907cc52498573ee", "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308", "tracking_id": "track_8RFQINPxgc+pykybVOUEXQ==", "date": "2024-01-18T15:27:56.234000Z", "amount": 50, "order": { "id": "ord_8GGVSci7FUPX1UX94qBHQPSE", "source_id": null, "status": "PAID", "customer_id": "cust_IdgAFZxYwwHctOk9pPuMu308", "referrer_id": null, "amount": 2900, "total_amount": 2900, "items": [ { "object": "order_item", "product_id": "prod_0df14b684f58f282d4", "quantity": 1, "amount": 2900, "price": 2900, "subtotal_amount": 2900 } ], "metadata": {}, "created_at": "2024-01-18T15:27:56.175354Z", "object": "order" }, "reward": { "customer": { "id": "cust_IdgAFZxYwwHctOk9pPuMu308", "name": "Jack Webhook", "email": null, "source_id": "jck-wbhk", "metadata": { "region": "EMEA" }, "object": "customer" }, "assignment_id": "rewa_XiIei2UpOYkLQxZ4J3U2pYlK", "product": { "id": "prod_0df14b7e7d8975079d", "source_id": "star-th-bottle", "name": "Star Thermal Bottle" }, "id": "rew_oOrlSAeYmfh6gYGOH7JMYVzv", "object": "reward", "name": "Material", "created_at": "2024-01-18T15:17:20.072326Z", "updated_at": null, "parameters": { "product": { "id": "prod_0df14b7e7d8975079d", "sku_id": null } }, "type": "MATERIAL" }, "customer": { "id": "cust_IdgAFZxYwwHctOk9pPuMu308", "name": "Jack Webhook", "email": null, "source_id": "jck-wbhk", "metadata": { "region": "EMEA" }, "object": "customer" }, "result": "SUCCESS", "status": "SUCCEEDED", "voucher": { "id": "v_hjQhSsitD6lAATASbRV1Ef7dUCjpy0iw", "code": "L0y4L", "loyalty_card": { "points": 900, "balance": 850 }, "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:27:56.228461Z", "redemption": { "quantity": null, "redeemed_quantity": 1, "redeemed_points": 50 }, "object": "voucher" }, "metadata": { "location_id": [] }, "object": "redemption" }, "reward": { "assignment_id": "rewa_XiIei2UpOYkLQxZ4J3U2pYlK", "product": { "id": "prod_0df14b7e7d8975079d", "source_id": "star-th-bottle", "name": "Star Thermal Bottle" }, "id": "rew_oOrlSAeYmfh6gYGOH7JMYVzv", "object": "reward", "name": "Material", "type": "CAMPAIGN" }, "referral_tier": null, "balance": null, "custom_event": null, "customer_event": null }
Response

Language
Click Try It! to start a request and see the response here! Or choose an example:
application/json