Introduction
The lifecycle of applying a loyalty program to an order follows a clear three-step process, with your system receiving webhooks at each stage.
Webhooks
| Webhook | Method | Purpose |
|---|---|---|
| Loyalty Programs | POST | This webhook is called to get a list of all loyalty programs a customer is eligible for. Your system should respond with a list of programs, which our channel partners will use to populate a list of available rewards in their user interfaces. |
| Validate Programs | POST | This webhook is called to validate that selected programs are applicable to the current basket. Your system should respond with the specific discounts that should be applied to the order. |
| Loyalty Order Notification | POST | This webhook is triggered when an order is finalized and placed or when an order is cancelled. When an order is created, your system should handle the automatic redemption of all applied loyalty programs in the basket. This includes deducting loyalty points, marking coupons as used, or processing any other redemption logic. |
| Cancel Loyalty Order | POST | This webhook is triggered when an order is is cancelled. For order cancelation, your system should revert any transactions or redemptions that were performed for that order, ensuring that loyalty points are returned and any program usage is undone. |