Rewards
The Reward Webhook delivers a reward payload any time a user obtains a reward voucher on a pathway. The payload contains an array of rewards
in the data
property and each reward object contains a list of vouchers
that have not been redeemed.
Payload Example
Key | Type |
pathway | Object. The name and SKU of the related pathway. |
rewards | Array. A list of rewards. |
Reward Object
Key | Type |
ID | String. ID or SKU reference for the reward. |
name | String. Name of the reward. |
vouchers | Array. A list of unredeemed vouchers. |
Voucher Object
The voucher object will contain a guid
which is used in the consume endpoint for rewards. This will allow integrations to set the voucher state if the intention is to manage redemption of awards via external systems.
Key | Type |
guid | String. A GUID of the voucher. |
state | String. The state of the voucher (pending, notified, verify, redeemed, expired). |
expires | String. The date the voucher expires. |
firstname | String |
lastname | String |
String | |
country | String |
city | String |
Last updated