Event - Reward Notification
This event is generated when a guest earns a redeemable. These events are triggered as they happen in the Punchh system based on configuration.
{
"content_id": "CONTENT_ID_GOES_HERE",
"timestamp": 1619695600,
"business_id": 6,
"business_uuid": "BUSINESS_UUID_GOES_HERE",
"business_slug": "slugname",
"event_name": " transactional_notifications",
"event_type": "reward_notification",
"action": "create",
"payload": {
"becomes_available_at": "2023-04-29T04:25:14-07:00",
"created_at": "2023-04-29T11:25:14Z",
"description": null,
"discount_amount": null,
"discount_channel": null,
"expiring_at": null,
"expiring_at_tz": null,
"gift_reason": "Loyalty Reward",
"name": "Free Pasta with Tomato and Basil",
"redeemable_id": 20,
"remaining_days": null,
"reward_id": 4602,
"reward_image_url": "REWARD_IMAGE_URL_GOES_HERE",
"reward_points_redeemed": 31,
"status": "unredeemed",
"updated_at": "2023-04-29T11:25:14Z",
"user": {
"account_balance": {
"banked_currency": null,
"current_membership_level_name": "Silver Level",
"last_visit": "2023-04-29T11:05:39Z",
"loyalty_points": 93,
"net_balance": 95,
"net_debits": 0,
"pending_points": 20,
"total_credits": 95,
"total_debits": "0.0",
"total_lifetime_points": 95,
"total_point_credits": 95,
"total_redeemable_visits": null,
"total_visits": 4,
"unbanked_points": null,
"unredeemed_cards": null,
"user_id": 111111111
},
"anniversary": "2000-01-01",
"avatar_remote_url": null,
"birthday": "1964-01-01",
"email": "test@example.com",
"first_name": "FIRST_NAME_GOES_HERE",
"gender": "male",
"guest_type": "Loyalty",
"last_activity_at": "2023-04-29T11:05:52Z",
"last_name": "LAST_NAME_GOES_HERE",
"marketing_email_subscription": true,
"marketing_pn_subscription": true,
"phone": "1111111111",
"preferred_locale": "en",
"secondary_email": "test1@example.com",
"signup_channel": "MobileEmail",
"sms_subscription": false,
"unsubscribe_reason": null,
"unsubscribed": false,
"user_id": 111111111,
"user_status": "active"
}
}
}
Meta Fields
Meta Fields are common attributes such as content_id, timestamp, etc. that are returned in event responses, providing additional information about events. Click here to view the descriptions of the attributes.
Response Parameters
| Payload | ||
| becomes_available_at | Date_time | Date/time at which the reward becomes redeemable by an end-user |
| created_at | Date_time | Date/time when the reward was created for an end-user in the system |
| description | String | Description of the reward |
| discount_amount | Integer | Discount amount associated |
| discount_channel | String | Channels where the reward can be used. Possible values are: 1. "online_only" for online orders 2. "offline_only" for POS 3. "all" for both |
| expiring_at | Date_time | Date/time when the reward expires |
| expiring_at_tz | Date_time | Expiry date/time of the reward with time zone |
| gift_reason | String | Gift reason for reward gifted to user |
| name | String | Name of the reward |
| redeemable_id | Integer | Redeemable ID |
| remaining_days | Integer | Remaining days for the expiry of the reward |
| reward_id | Integer | Unique ID of the reward |
| reward_image_url | String | URL of the image depicting the reward |
| reward_points_redeemed | Integer | Reward points redeemed by the user |
| status | String | Status includes: honored, unredeemed, perished, expired Note: The "expired" and "perished" values for the status parameter have been deprecated. |
| updated_at | Date_time | Date/time when the reward was updated for an end-user in the system |
| User | Object | See the user object in Event - Rewards Expiry Reminder |
| user.account_balance | Object | See the account_balance object in Event - Guest |