Reward category events
The following webhook event is supported under Reward category:
Reward status
Tango supports sending webhook events when reward status changes. Subscribing to the RewardStatus
event ensures you receive timely notifications for changes such as rewards becoming frozen, unfrozen, cancelled, etc. To subscribe to reward status events, create a subscription using POST {URI}/webhooks
,then select RewardStatus
for the event type and REWARD
for the category.
Use case
Acme, a wellness incentive company, wants to be notified when:
- A recipient activates their physical prepaid MasterCard or Visa card that has been mailed to them.
- A recipient receives a plastic card in the mail and activates it.
- A Choice Product is frozen, unfrozen, cancelled, or reissued.
- A Choice Product is partially or fully redeemed.
Using RewardStatus
Acme receives a notification indicating the status change.
List of reward statuses
The following statuses are returned with RewardStatus
:
Reward status | Description |
---|---|
FROZEN | The Choice Product is frozen and cannot be redeemed by the recipient. Unfreeze the reward to allow redemption. |
UNFROZEN | The Choice Product is unfrozen and ready to be redeemed by the recipient. |
CANCELLED | The Choice Product has been cancelled and cannot be redeemed by the recipient. The funds have been refunded for this reward. Send new rewards if needed. |
ACTIVATED | This status is used for physical open-loop cards where the recipient activates the card. Approval is required to receive this status. |
PARTIAL_REDEMPTION | The recipient partially redeems a Choice Product. The balance is not zero (<> $0), meaning the product still has some value left after the partial redemption. |
FULL-REDEMPTION | The recipient fully redeems a Choice Product. The balance is zero (=$0) and the product does not have any value left after the full redemption. |
When creating a subscription for reward status, use thePOST {URI}/webhooks
and enter the following values:
Body Params | Type | Description |
---|---|---|
url | string | Enter the URL of your webhook listener. It must be a valid URL. (Required) |
categories | array of strings | Enter Reward for categories. (Optional if you're specifying eventTypes.) |
eventTypes | array of strings | Enter RewardStatus for eventTypes. (Optional if you're specifying categories.) |
Here is a response payload of RewardStatus
:
"category": "REWARD",
"eventType": "RewardStatus",
"eventOccurredAt": "2024-11-09T04:25:36.4844028Z",
"eventData": {
"referenceLineItemId": "RG241108-3077508-11-1",
“type”: rewardtype,
"status": “FROZEN”, “UNFROZEN”, “CANCELLED”, “ACCESSED”, “PARTIAL_REDEMPTION”, “FULL_REDEMPTION”
"action": <“FREEZE”, “UNFREEZE”, “CANCEL”, "REISSUE">
"newReferenceLineItemID": "RG241108-3077518-12-1",
"reasonCode": <enumeration>
"reason": <text description> [100 chars]
}
The following response messages are supported by webhook endpoints in Tango API:
- 201 Created
- 400 Bad Request
- 401 Unauthorized
Updated 4 days ago