Event - Rewards Expiry Reminder

This event is generated a configured number of days before the expiry of a guest's 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_expiry_reminder",  
  "action": "create",  
  "payload": {
    "becomes_available_at": "2023-04-29T04:25:14-07:00",
    "created_at": "2023-04-29T11:25:14Z",
    "description": "Free Burger",
    "discount_amount": 5,	
    "discount_channel": "all",
    "expiring_at": "2023-04-30T06:59:59Z",
    "expiring_at_tz": "2023-04-29T23:59:59-07:00",
    "gift_reason": "Support Activity",
    "name": "Free Burger",
    "redeemable_id": 60,
    "remaining_days": 0,
    "reward_id": 4584,
    "reward_image_url": "REWARD_IMAGE_URL_GOES_HERE",
    "reward_points_redeemed": null,
    "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": 5831
    },		
    "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": 5831,			
    "user_status": "active",
    "apple_loyalty_pass_url": "APPLE_LOYALTY_PASS_URL_GOES_HERE",
    "android_loyalty_pass_url": "ANDROID_LOYALTY_PASS_URL_GOES_HERE"
  }
 }
}

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

Name	Type	Description
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 (int64)	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
user.anniversary	Date	Anniversary of the user
user.avatar_remote_url	String	Avatar remote URL
user.birthday	Date	Birthday of the user
user.email	String	Email address of the user
user.external_source	String	Signifies the external source user identifier ingested from
user.external_source_id	String	Returns the ID stored in Punchh against the external source. If external_source is not being used or is blank, then by default it will return Punchh user_id.
user.first_name	String	First name of the user
user.gender	String	Gender of the user
user.guest_type	String	Guest type (i.e., eClub or loyalty)
user.last_activity_at	Date_time	User’s last activity timestamp
user.last_name	String	Last name of the user
user.marketing_email_subscription	Boolean	Whether the end-user has subscribed to marketing emails or not
user.marketing_pn_subscription	Boolean	Whether the end-user has subscribed to marketing push notifications or not
user.phone	String	Phone number of the user
user.preferred_locale	String	Preferred language code of the user
user.secondary_email	String	Secondary email of the user is configured when a user signs up with Facebook but does not share the email ID. The app asks for an alternate email, which is kept as the `secondary_email`.
user.signup_channel	String	Sign-up channel of the user
user.sms_subscription	Boolean	Whether the end-user has subscribed to SMS services or not
user.unsubscribe_reason	String	Unsubscribe reason
user.unsubscribed	Boolean	Unsubscribe status
user.user_id	Integer	User ID generated in Punchh
user.user_status	String	Status of the user (i.e., active or ban or deactivate)
user.apple_loyalty_pass_url	String	URL for the guest to save their Apple Wallet loyalty pass. Included when passes are enabled for the business. Contact your Punchh representative to update this Punchh platform configuration.
user.android_loyalty_pass_url	String	URL for the guest to save their Google Wallet loyalty pass. Included when passes are enabled for the business. Contact your Punchh representative to update this Punchh platform configuration.
user.account_balance	Object	See the account_balance object in Event - Guest

Reward Notification

Update Check-in