Braze Event - Guest

This includes user create/update events triggered as they happen in the Punchh system.

In a user update event, the previous_changes attribute (array) contains updated user attributes tracked as database field changes. Certain attributes are always included in payload even though they are not present in previous_changes, such as apple_loyalty_pass_url, android_loyalty_pass_url and account balance information.

When Disable sending default user attributes to Braze is set to No, all supported user attributes are included in the event payload along with the updated user attributes in previous_changes.

When the setting is set to Yes, only attributes present in previous_changes are generally included, along with certain attributes mentioned above are always included.

For more information, see the Exclude User Profile Data From Custom Events section in Braze Webhooks Adapter Overview.

Note: Punchh sends guest events for users with the following statuses: active, banned, or deactivated. Guest events are not sent 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.

{
    "attributes": [
     {
      "last_name": "LAST_NAME_GOES_HERE",
      "punchh_user_id": 18268,
      "signup_channel": "MobileEmail",
      "account_balance_total_point_credits": 0,
      "email_subscribe": "subscribed",
      "external_id": "EXTERNAL_ID_GOES_HERE",
      "favourite_store_numbers": "",
      "terms_and_conditions": false,
      "account_balance_current_membership_level_name": "Silver Level",
      "account_balance_net_balance": 0,
      "confirmation_sent_at": "2021-08-16T15:01:46Z",
      "referral_code": "REFERRAL_CODE_GOES_HERE",
      "user_status": "active",
      "account_balance_total_lifetime_points": 0,
      "email": "test@example.com",
      "push_subscribe": "subscribed",
      "time_zone": "Asia/Kolkata",
      "date_of_last_session": "2021-08-16T15:01:45Z",
      "first_name": "FIRST_NAME_GOES_HERE",
      "guest_type": "Loyalty",
      "sms_subscription": false,
      "account_balance_net_debits": 0,
      "business_uuid": "BUSINESS_UUID_GOES_HERE",
      "current_sign_in_at": "2021-08-16T15:01:45Z",
      "date_of_first_session": "2021-08-16T15:01:45Z",
      "apple_loyalty_pass_url": "APPLE_LOYALTY_PASS_URL_GOES_HERE",
      "android_loyalty_pass_url": "ANDROID_LOYALTY_PASS_URL_GOES_HERE"
      }
    ]
}

Response Parameters

Name	Type	Description
email_subscribe	String	Status of the user's email subscription
external_id	String	ID stored in Punchh against the external source
account_balance_current_membership_level_name	String	Name of the current membership level of a user
account_balance_net_balance	Float	Net available balance of the current account. This value always shows the available balance of the user whether visits, banked rewards, or points.
account_balance_total_lifetime_points	Float	Sum of all the loyalty points earned by a user from the time the user signed up (excluding expired points)
push_subscribe	String	Status of the user's push notification subscription
time_zone	String	Time zone of the user
date_of_last_session	Date_time	Most recent date and time when the user accessed the system
account_balance_net_debits	Float	Total points redeemed/donated/transferred by the user
current_sign_in_at	Date_time	Date and time when the user most recently logged into the system
date_of_first_session	Date_time	Date and time when the user first accessed the system
previous_changes	Array	Lists the specific user attributes that have been updated in a particular event within the Punchh system. For example, if the phone number and address are updated in the guest profile, `previous_changes` will only include the keys for the attributes that were updated - in this case, "phone" and "address".
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. Note: `apple_loyalty_pass_url` and `android_loyalty_pass_url` are always included in "guest_create" and "guest_update", regardless of the Disable sending default user attributes to Braze setting. These attributes do not appear in the `previous_changes` array because their values are computed dynamically and are not tracked as database field updates. For other events (for example, Loyalty Check-in), these attributes are included or excluded from the guest data based on the value of the Disable sending default user attributes to Braze setting. See Exclude User Profile Data from Custom Events
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. See the note in `apple_loyalty_pass_url` above for inclusion behavior details.

See the table in the Response Parameters section in Event - Guest for descriptions of the remaining parameters.

Braze Event - Gift Check-in

Braze Event - Loyalty Check-in