Event - User Notification

This event is generated when a guest signs up in the Punchh system via the mobile app. These events are triggered as they happen in the Punchh system based on configuration.

{
  "content_id": "CONTENT_ID_GOES_HERE",	
  "timestamp": 1619694452,	
  "business_id": 6,	
  "business_uuid": "BUSINESS_UUID_GOES_HERE",	
  "business_slug": "slugname",	
  "event_name": "transactional_notifications",	
  "event_type": "user_signup",	
  "action": "create",	
  "payload": {	  
    "account_balance": {		
      "banked_currency": null,				
      "current_membership_level_name": "Gold",				
      "last_visit": "2023-04-29T07:00:33Z",				
      "loyalty_points": 60,				
      "net_balance": 20,				
      "net_debits": 100,				
      "pending_points": 0,				
      "total_credits": 120,				
      "total_debits": "100.0",				
      "total_lifetime_points": 120,				
      "total_point_credits": 120,				
      "total_redeemable_visits": null,				
      "total_visits": 3,				
      "unbanked_points": null,				
      "unredeemed_cards": null,				
      "user_id": 5752				
    },
    "anniversary": null,			
    "avatar_remote_url": null,			
    "birthday": null,			
    "email": "test@example.com",
    "email_confirmation_url": "EMAIL_CONFIRMATION_URL_GOES_HERE",
    "external_source_id": "SOURCE_ID_GOES_HERE",			
    "first_name": "FIRST_NAME_GOES_HERE",			
    "gender": "Male",			
    "guest_type": "Loyalty",			
    "last_activity_at": "2023-04-29T07:00:33Z",			
    "last_name": "LAST_NAME_GOES_HERE",			
    "marketing_email_subscription": true,			
    "marketing_pn_subscription": true,			
    "phone": "1111111111",			
    "preferred_locale": "en",
    "reset_password_url": null,			
    "secondary_email": "test1@example.com",			
    "signup_channel": "MobileEmail",			
    "sms_subscription": false,			
    "unsubscribe_reason": null,			
    "unsubscribed": false,			
    "user_id": 5752,			
    "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
account_balance	Object	See the account_balance object in Event - Guest
anniversary	Date	Anniversary date of the end-user in YYYY-MM-DD format
avatar_remote_url	String	Avatar remote URL
birthday	Date	Birthday of the user in YYYY-MM-DD format
email	String	Email address of the user
email_confirmation_url	String	Email confirmation URL
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.
first_name	String	First name of the user
gender	String	Gender of the user
guest_type	String	Type of the user (i.e., eClub or loyalty)
last_activity_at	Date_time	User’s last activity timestamp
last_name	String	Last name of the user
marketing_email_subscription	Boolean	Whether the end-user has subscribed to marketing emails or not
marketing_pn_subscription	Boolean	Whether the end-user has subscribed to marketing push notifications or not
phone	String	Phone number of the user
preferred_locale	String	Preferred language
reset_password_url	String	Reset password URL
secondary_email	String	Secondary email of the user is configured when a user signs up with Facebook but does not share the email address. The app asks for an alternate email address, which is kept as the `secondary_email`.
signup_channel	String	Sign-up channel of the user
sms_subscription	Boolean	Whether the end-user has subscribed to SMS services or not
unsubscribe_reason	String	Unsubscribe reason
unsubscribed	Boolean	Unsubscribe status
user_id	Integer	User ID generated by the Punchh system
user_status	String	Status of the user (i.e., active, banned, or deactivated) Note: Punchh does not send guest events for users with deleted, anonymized, or archived status, as personally identifiable information (PII) is not stored once a guest is moved into these statuses.

Update Check-in

Visits Expiry Reminder