Event - Card Completion
This event is generated when a guest's loyalty card gets completed. 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": "card_completion",
"action": "create",
"payload": {
"base_redeemable": {
"applicable_as_loyalty_redemption": false,
"created_at": "2023-02-03T07:10:45Z",
"description": null,
"discount_amount": 12,
"discount_channel": null,
"expire_redemption_code_with_reward_end_date": null,
"expiry_date": null,
"meta_data": null,
"name": "Redeemable - 1",
"points_required_to_redeem": 19,
"redeemable_id": 12119,
"redeemable_image_url": "REDEEMABLE_IMAGE_URL_GOES_HERE",
"redeemable_properties": null,
"redemption_expiry": 240,
"status": "activated",
"updated_at": "2023-02-03T07:10:45Z"
},
"card_completion": true,
"first_card_reminder": false,
"first_name": "FIRST_NAME_GOES_HERE",
"second_card_reminder": false,
"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 | ||
| Base Redeemable | Object | |
| base_redeemable.applicable_as_loyalty_redemption | Boolean | Whether redeemables are allowed for loyalty reward redemption or not |
| base_redeemable.created_at | Date_Time | Date and time when the redeemable was created for an end-user in the system |
| base_redeemable.description | String | Description of the redeemable that appears in the app |
| base_redeemable.discount_amount | Integer | Discount amount associated with the redeemable |
| base_redeemable.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 |
| base_redeemable. expire_redemption_code_with_reward_end_date |
Boolean | Whether the redemption code is to expire along with the reward end date or not |
| base_redeemable.expiry_date | Date | Expiry date of the redeemable |
| base_redeemable.meta_data | String | Meta data that can be added to a redeemable. This can be used to program mobile apps to have certain behavior when specific data are received from the server, or can be used as the business wants. This can be configured from the Punchh platform and has a maximum length of 255 characters. |
| base_redeemable.name | String | Name of the reward |
| base_redeemable.points_required_to_redeem | Integer | Value of points required to redeem a particular redeemable |
| base_redeemable.redeemable_id | Integer | Unique ID to identify a redeemable in the system |
| base_redeemable.redeemable_image_url | String | URL of the image that is displayed in the app to depict the redeemable |
| base_redeemable.redeemable_properties | String | Properties such as "Merchandise", "Food Item", etc. added to a particular redeemable |
| base_redeemable.redemption_expiry | String | Expiry of the redemption as configured on the Punchh platform |
| base_redeemable.status | String | Status of the redeemable includes: activated, deactivated, draft, expired |
| base_redeemable.updated_at | Date_Time | Date and time when the redeemable was updated for an end-user in the system. |
| card_completion | Boolean | Whether required visits are made for single card completion or not |
| first_card_reminder | Boolean | Whether a reminder is sent on completion of the first card or not |
| first_name | String | First name of the user |
| second_card_reminder | Boolean | Whether a reminder is sent on completion of the second card or not |
| User | Object | See the user object in Event - Rewards Expiry Reminder |
| user.account_balance | Object | See the account_balance object in Event - Guest |