Event - Post Check-in Campaign Notification

This includes information about post-check-in campaign notification events triggered as they happen in the Punchh system.

{
  "content_id": "CONTENT_ID_GOES_HERE",
  "timestamp": 1595593863,
  "business_id": 7,
  "business_uuid": "BUSINESS_UUID_GOES_HERE",
  "event_name": "marketing_notifications",
  "event_type": "post_checkin_campaign",
  "action": "create",
  "payload": {
    "campaign_id": 18,
    "campaign_name": "Post Checkin - Message",
    "campaign_type": "NotificationBearing",
    "checkin_id": 26050,
    "coupon_code": "CUVJYZQB27",
    "coupon_end_date": "2023-10-29",
    "days_of_week": "all week",
    "extra_points": null,
    "gift_reason": null,
    "gifted_amount": null,
    "hours_of_day": "all day",
    "location_name": "",
    "reward_expiring_at": null,
    "reward_expiring_at_tz": null,
    "reward_id": null,
    "reward_name": null,
    "schedule": "all day all week",
    "user": {
      "account_balance": {
        "banked_currency": null,
        "current_membership_level_name": "Silver Level",
        "last_visit": null,
        "loyalty_points": 0,
        "net_balance": 10,
        "net_debits": 0,
        "pending_points": 0,
        "total_credits": 10,
        "total_debits": "0.0",
        "total_lifetime_points": 10,
        "total_point_credits": 10,
        "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": "2023-04-24T12:30:50Z",
      "last_name": "LAST_NAME_GOES_HERE",
      "marketing_email_subscription": true,
      "marketing_pn_subscription": true,
      "phone": "1111111111",
      "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
campaign_id	Integer	ID of the updated campaign
campaign_name	String	Name of the updated campaign
campaign_type	String	Type of the campaign
checkin_id	String	Unique check-in ID generated by Punchh
coupon_code	String	Code of the coupon
coupon_end_date	Date	Coupon validity end date
days_of_week	String	Configuration detail of post check-in campaign will run on which day of the week
extra_points	Integer	Gifting points
gift_reason	String	Reason/purpose message for gifting
gifted_amount	Integer	Amount gifted to the user
hours_of_day	String	Configuration detail of post check-in campaign will run on which hour of the day
location_name	String	Location name of the check-in
reward_expiring_at	Date	Expiry date of the reward
reward_expiring_at_tz	Date_time	Expiry date of the reward with time zone
reward_id	Integer	Unique ID of the reward
reward_name	String	Name of the reward
schedule	String	Schedule configuration of the campaign to be run
User	Object	See the user object in Event - Rewards Expiry Reminder
user.account_balance	Object	See the account_balance object in Event - Guest

Post Check-in Campaign Gift

Post Payment Campaign