Event - Rewards

This includes user rewards gifted/issued events triggered as they happen in the Punchh system based on configuration or activity.

{
  "content_id": "CONTENT_ID_GOES_HERE",
  "timestamp": 1595512879,
  "business_id": 7,
  "business_uuid": "BUSINESS_UUID_GOES_HERE",
  "event_name": "rewards",
  "event_type": "",
  "action": "create",
  "payload": {
    "becomes_available_at": "2020-07-23T07:01:11-07:00",
    "campaign_id": 105,
    "campaign_name": "Signup - Free Burger",
    "campaign_type": "SignupCampaign",
    "created_at": "2020-07-23T14:01:11Z",
    "description": "Test Desciption",
    "discount_amount": null,
    "discount_channel": "all",
    "expiring_at": null,
    "expiring_at_tz": null,
    "franchisee_id": null,
    "gift_reason": "through Signup - Free Burger",
    "gifted_for_id": 105,
    "gifted_for_type": "Campaign",
    "meta_data": "meta1,meta2",
    "name": "Free Burger",
    "read_at": null,
    "redeemable_created_at": "2020-05-11T12:42:47Z",
    "redeemable_id": 107,
    "redemption_id": null,
    "reward_id": 6973,
    "reward_image_url": "IMAGE_URL_GOES_HERE",
    "reward_points_redeemed": 100,
    "reward_properties": "Donatable X",
    "status": "unredeemed",
    "store_numbers": [],
    "updated_at": "2020-07-23T14:01:11Z",
    "user": {
      "account_balance": {
        "banked_currency": null,
        "current_membership_level_name": "Silver Level",
        "last_visit": null,
        "loyalty_points": 0,
        "net_balance": 5,
        "net_debits": 0,
        "pending_points": 0,
        "total_credits": 5,
        "total_debits": "0.0",
        "total_lifetime_points": 5,
        "total_point_credits": 5,
        "total_redeemable_visits": null,
        "total_visits": 0,
        "unbanked_points": null,
        "unredeemed_cards": null,
        "user_id": 111111111
      },
      "anniversary": null,
      "avatar_remote_url": null,
      "birthday": "1999-01-01",
      "email": "test@example.com",
      "first_name": "FIRST_NAME_GOES_HERE",
      "gender": null,
      "guest_type": "Loyalty",
      "last_activity_at": "2020-07-23T14:00:56Z",
      "last_name": "User",
      "marketing_email_subscription": true,
      "marketing_pn_subscription": true,
      "phone": null,
      "preferred_locale": "en",
      "secondary_email": null,
      "signup_channel": "WebEmail",
      "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
campaign_id	Integer	Campaign ID
campaign_name	String	Campaign name
campaign_type	String	Informs about the type of campaign through which an end-user got a reward. Currently, the only possible value is "loyalty". A "null" value signifies that the end-user did not get the reward through any campaign.
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	Date/time when the reward expires
expiring_at_tz	Date_time	Expiry date of the reward with time zone
franchisee_id	Integer	ID of the franchisee who credited the reward to the end-user's account. This could be through a campaign or admin generosity.
gift_reason	String	Gift reason for reward gifted to user
gifted_for_id	Integer	ID for the type of gifting
gifted_for_type	String	Type of gifting (i.e., mass gifting, feedback reply, game, etc.)
meta_data	String	Meta data that can be added to a redeemable. This can be used to program mobile apps to have a certain behavior when specific data are received from the server. Or it can be used as the business wishes. This can be configured from the Punchh platform and has a maximum length of 255 characters.
name	String	Name of the reward
read_at	Date_time	Date/time when the reward's notification was read by an end-user in the app
redeemable_created_at	Date_time	Date/time when the redeemable was created in the Punchh platform
redeemable_id	Integer	Redeemable ID
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
reward_properties	String	Additional properties of the reward (e.g., "merchandise", "order ahead", "promo", etc.) that can be configured in the platform
status	String	Status includes: honored, unredeemed, perished, expired Note: The "expired" and "perished" values for the status parameter have been deprecated.
store_numbers	Array of strings	Store numbers of all locations where the reward can be redeemed. An empty array signifies that the reward is redeemable at any location.
updated_at	Date	Date/time when the reward was updated for an end-user in the system
redemption_id	Integer	Unique ID associated with the redemption
User	Object
user.account_balance	Object	See the account_balance object in Event - Guest
user.anniversary	Date	Anniversary of the user
user.birthday	Date	Birthday of the user
user.email	String	Email address of the user
user.first_name	String	First name of the user
user.guest_type	String	Guest type (i.e., eClub or loyalty)
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	Integer	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.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, banned, or deactivated) Note: Punchh does not send guest events for deleted, anonymized, or archived users, as personally identifiable information (PII) is not stored once a guest is moved into these statuses. However, if the option to generate events for deleted guests is enabled for the business in the Punchh platform, events will be sent for deleted users.

Event - Redemptions

Bumped Membership Level