Event - POS Scanner Check-in
This event is generated after a customer check-in is completed at the POS or via Online Ordering. These events are triggered as they happen in the Punchh system based on configuration.
Note: It does not track the scanning of a QR code — meaning it is not triggered by a scan and contains no QR code data. The term 'Scanner' does not refer to a physical scan action.
{
"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": "pos_scanner_checkin",
"action": "create",
"payload": {
"points": "$100",
"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",
"external_source": "",
"external_source_id": "SOURCE_ID_GOES_HERE",
"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 | ||
| Points | Integer | Points earned from check-in |
| User | Object | See the user object in Event - Rewards Expiry Reminder |
| user.account_balance | Object | See the account_balance object in Event - Guest |
| user_name | String | Username that identifies the user in the system |