mParticle Event - Marketing Notifications

Marketing Notifications events are triggered at the user level for any campaign-related activity. These events are further categorized by event types in the payload, such as signup_campaign, post_checkin_campaign, etc. The event attributes will vary depending on the specific type of notification event.

Sample Payload for Post Check-in Campaign Notification

{
  "source_request_id": null,
  "events": [
    {
      "data": {
        "custom_event_type": "other",
        "event_name": "marketing_notifications",
        "custom_flags": {},
        "timestamp_unixtime_ms": "1621001413569",
        "event_id": "-4740650914051046789",
        "source_message_id": null,
        "session_start_unixtime_ms": "0",
        "event_start_unixtime_ms": "0",
        "custom_attributes": {
          "campaign_id": "18",
          "campaign_name": "Post Checkin - Message",
          "campaign_type": "NotificationBearing",
          "checkin_id": "26153",
          "coupon_code": "C5RKBAAE11",
          "coupon_end_date": "2021-04-29",
          "days_of_week": "all week",
          "event_action": "create",
          "event_name": "marketing_notifications",
          "event_type": "post_checkin_campaign",
          "hours_of_day": "all day",
          "location_name": "",
          "schedule": "all day all week"
        },
        "is_goal_defined": false,
        "lifetime_value_change": 0,
        "lifetime_value_attribute_name": null,
        "data_connection_type": null,
        "event_num": 0,
        "view_controller": null,
        "is_main_thread": null,
        "canonical_name": null,
        "event_system_notification_info": null
      },
      "event_type": "custom_event"
    }
  ],
  "user_attributes": {
    "Punchh_account_balance_current_membership_level_name": "Silver Level",
    "Punchh_account_balance_last_visit": "2021-05-14T14:09:07Z",
    "Punchh_account_balance_loyalty_points": "69",
    "Punchh_account_balance_net_balance": "69",
    "Punchh_account_balance_net_debits": "0",
    "Punchh_account_balance_pending_points": "0",
    "Punchh_account_balance_total_credits": "69",
    "Punchh_account_balance_total_debits": "0.0",
    "Punchh_account_balance_total_lifetime_points": "69",
    "Punchh_account_balance_total_point_credits": "69",
    "Punchh_account_balance_total_visits": "3",
    "Punchh_business_id": "6",
    "Punchh_email": "test@example.com",
    "Punchh_first_name": "FIRST_NAME_GOES_HERE",
    "Punchh_gender": "Male",
    "Punchh_guest_type": "Loyalty",
    "Punchh_last_activity_at": "2021-05-14T14:09:07Z",
    "Punchh_last_name": "LAST_NAME_GOES_HERE",
    "Punchh_marketing_email_opt_in": "True",
    "Punchh_marketing_email_subscription": "True",
    "Punchh_marketing_pn_opt_in": "True",
    "Punchh_marketing_pn_subscription": "True",
    "Punchh_secondary_email": "test01@example.com",
    "Punchh_signup_channel": "MobileEmail",
    "Punchh_sms_subscription": "False",
    "Punchh_unsubscribed": "False",
    "Punchh_user_id": "5852",
    "Punchh_user_status": "active",
    "Punchh_address": "Mi Road",
    "Punchh_city": "Jaipur",
    "Punchh_confirmation_sent_at": "2021-04-30T12:09:12Z",
    "Punchh_created_at": "2021-04-30T12:09:12Z",
    "Punchh_current_sign_in_at": "2021-04-30T12:09:12Z",
    "Punchh_current_sign_in_ip": "10.77.41.237",
    "Punchh_invite_code": "INVITE_CODE_GOES_HERE",
    "Punchh_joined_at": "2021-04-30T12:09:12Z",
    "Punchh_last_sign_in_at": "2021-04-30T12:09:12Z",
    "Punchh_last_sign_in_ip": "10.77.41.237",
    "Punchh_last_user_agent": "MyRewards/2.0/2 (x86_64; iOS 10.3; Scale/2.00)",
    "Punchh_referral_code": "Rohcyd4778",
    "Punchh_referred_by_id": "5785",
    "Punchh_state": "Rajasthan",
    "Punchh_terms_and_conditions_opt_in": "True",
    "Punchh_updated_at": "2021-04-30T12:09:12Z",
    "Punchh_zip_code": "302012",
    "Punchh_favorite_location": [
      "107"
    ],
    "Punchh_favorite_store_numbers": [
      "4456"
    ]
  },
  "deleted_user_attributes": null,
  "user_identities": {
    "email": "test@example.com"
  },
  "environment": "development",
  "ip": "",
  "integration_attributes": null,
  "source_info": {
    "channel": "partner",
    "partner": "Punchh",
    "replay_request_id": null,
    "replay_job_id": null,
    "is_historical": false
  }
}

Response Parameters

The section lists the common parameters returned in all marketing event payloads.

Events
data.custom_attributes.event_action String Operation associated with the event (e.g., create/update/delete for user, POS/console/online for check-ins, etc.)
data.custom_attributes.event_name String Name of the event, such as user, check-ins, redemption, etc.
data.custom_attributes.event_type String Type of the event (e.g., gift or loyalty for check-ins, etc.)

See the table in the Response Parameters section of mParticle Event - Guest for descriptions of the parameters in the user_attributes object.

Marketing Notification Events

Here is the list of marketing event types:

Anniversary Campaign

Challenge Campaign

Compression Campaign

Coupon Campaign

Post Check-in Campaign Gift

Post Check-in Campaign Notification

Post Payment Campaign

Profile Update Campaign

Promo Campaign Notification

Recall Campaign

Referral Campaign

Sign-up Campaign

Social Cause Campaign