From b0dcc4ebcfe2d69c3ebefa74ac4134c951031731 Mon Sep 17 00:00:00 2001 From: Ian Absher Date: Tue, 2 Jul 2024 10:30:28 -0700 Subject: [PATCH 1/5] Updating docs. --- .../customer_behavior_events.md | 308 +- .../message_engagement_events.md | 5418 ++++++++++------- 2 files changed, 3508 insertions(+), 2218 deletions(-) diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md index e4a71b45351..59f4d6a2e6f 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md @@ -61,23 +61,23 @@ This event occurs when a specific custom event is triggered. Use this to track w "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", - "name" : "(required, string) Name of the custom event", "ad_id" : "(optional, string) Advertising identifier", "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "device_model" : "(optional, string) Model of the device", + "name" : "(required, string) Name of the custom event", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -90,19 +90,19 @@ This event occurs when a specific custom event is triggered. Use this to track w { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "time" : "(required, int) Unix timestamp at which the event happened", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", - "$device" : "(optional, string) Model of the device", + "$partner_id" : "braze", "ad_id" : "(optional, string) Advertising identifier", "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "$device" : "(optional, string) Model of the device", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -141,14 +141,14 @@ This event occurs when a specific custom event is triggered. Use this to track w "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", "ad_id" : "(optional, string) Advertising identifier", "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_model" : "(optional, string) Model of the device", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -189,24 +189,24 @@ Purchases are special custom events and come with a JSON encoded string of custo "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", - "product_id" : "(required, string) ID of the product purchased", - "price" : "(required, float) Price of the purchase", - "currency" : "(required, string) Currency of the purchase", "ad_id" : "(optional, string) Advertising identifier", "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "currency" : "(required, string) Currency of the purchase", + "device_model" : "(optional, string) Model of the device", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "price" : "(required, float) Price of the purchase", + "product_id" : "(required, string) ID of the product purchased" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -219,22 +219,22 @@ Purchases are special custom events and come with a JSON encoded string of custo { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "time" : "(required, int) Unix timestamp at which the event happened", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "currency" : "(required, string) Currency of the purchase", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "product_id" : "(required, string) ID of the product purchased", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", "price" : "(required, float) Price of the purchase", - "currency" : "(required, string) Currency of the purchase", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "product_id" : "(required, string) ID of the product purchased", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -274,15 +274,15 @@ Purchases are special custom events and come with a JSON encoded string of custo "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", - "currency" : "(required, string) Currency of the purchase", "ad_id" : "(optional, string) Advertising identifier", "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "currency" : "(required, string) Currency of the purchase", + "device_model" : "(optional, string) Model of the device", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -326,20 +326,20 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "session_id" : "(optional, string) UUID of the session", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_model" : "(optional, string) Model of the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -352,17 +352,17 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "time" : "(required, int) Unix timestamp at which the event happened", - "session_id" : "(optional, string) UUID of the session", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -400,12 +400,12 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "session_id" : "(optional, string) UUID of the session", - "platform" : "(optional, string) Platform of the device", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_model" : "(optional, string) Model of the device", "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device" + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -444,17 +444,17 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "session_id" : "(optional, string) UUID of the session", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_model" : "(optional, string) Model of the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -467,17 +467,17 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "session_id" : "(optional, string) UUID of the session", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -512,10 +512,10 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "event_properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "session_id" : "(optional, string) UUID of the session", - "platform" : "(optional, string) Platform of the device", + "device_model" : "(optional, string) Model of the device", "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device" + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -552,20 +552,20 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "device_model" : "(optional, string) Model of the device", "duration" : "(optional, float) Duration of the session in seconds", - "session_id" : "(optional, string) UUID of the session", - "platform" : "(optional, string) Platform of the device", "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -578,18 +578,18 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "time" : "(required, int) Unix timestamp at which the event happened", - "duration" : "(optional, float) Duration of the session in seconds", - "session_id" : "(optional, string) UUID of the session", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", + "duration" : "(optional, float) Duration of the session in seconds", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -623,13 +623,13 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_model" : "(optional, string) Model of the device", "duration" : "(optional, float) Duration of the session in seconds", - "session_id" : "(optional, string) UUID of the session", - "platform" : "(optional, string) Platform of the device", "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device" + "platform" : "(optional, string) Platform of the device", + "session_id" : "(optional, string) UUID of the session" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -662,26 +662,26 @@ This event is triggered when a user visits a specified location. Use this to tra "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location", + "altitude" : "(optional, float) Altitude of recorded location", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "device_model" : "(optional, string) Model of the device", "latitude" : "(required, float) Latitude of recorded location", - "longitude" : "(required, float) Longitude of recorded location", - "altitude" : "(optional, float) Altitude of recorded location", "ll_accuracy" : "(optional, float) Accuracy of the latitude and longitude of recorded location", - "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location", - "platform" : "(optional, string) Platform of the device", + "longitude" : "(required, float) Longitude of recorded location", "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "platform" : "(optional, string) Platform of the device" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -694,24 +694,24 @@ This event is triggered when a user visits a specified location. Use this to tra { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location", + "altitude" : "(optional, float) Altitude of recorded location", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "time" : "(required, int) Unix timestamp at which the event happened", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "$device" : "(optional, string) Model of the device", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "latitude" : "(required, float) Latitude of recorded location", - "longitude" : "(required, float) Longitude of recorded location", - "altitude" : "(optional, float) Altitude of recorded location", "ll_accuracy" : "(optional, float) Accuracy of the latitude and longitude of recorded location", - "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", + "longitude" : "(required, float) Longitude of recorded location", "$os" : "(optional, string) Version of the operating system of the device", - "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "platform" : "(optional, string) Platform of the device", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -752,19 +752,19 @@ This event is triggered when a user visits a specified location. Use this to tra "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location", + "altitude" : "(optional, float) Altitude of recorded location", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_model" : "(optional, string) Model of the device", "latitude" : "(required, float) Latitude of recorded location", - "longitude" : "(required, float) Longitude of recorded location", - "altitude" : "(optional, float) Altitude of recorded location", "ll_accuracy" : "(optional, float) Accuracy of the latitude and longitude of recorded location", - "alt_accuracy" : "(optional, float) Altitude accuracy of recorded location", - "platform" : "(optional, string) Platform of the device", + "longitude" : "(required, float) Longitude of recorded location", "os_version" : "(optional, string) Version of the operating system of the device", - "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "platform" : "(optional, string) Platform of the device" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -802,14 +802,14 @@ This event occurs when an app installation is attributed to a source. Use this t "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "source" : "(optional, string) The source of the attribution", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "card_id" : "(optional, string) ID of the card this in app message comes from", + "source" : "(optional, string) The source of the attribution" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -822,13 +822,13 @@ This event occurs when an app installation is attributed to a source. Use this t { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "source" : "(optional, string) The source of the attribution", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md index 04e0c3731c2..1280ad82273 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md @@ -79,24 +79,29 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, long) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -109,21 +114,26 @@ This event occurs when an WhatsApp message sent made it successfully to the end- { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, long) Unix timestamp at which the event happened", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, long) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -137,16 +147,21 @@ This event occurs when an WhatsApp message sent made it successfully to the end- { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, long) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -168,22 +183,27 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -213,16 +233,21 @@ This event occurs when an WhatsApp message sent made it successfully to the end- { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -247,16 +272,21 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, long) Unix timestamp at which the event happened", "type" : "track", @@ -287,26 +317,31 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(required, string) Error code from WhatsApp", "provider_error_title" : "(required, string) Description of error from WhatsApp", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, long) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -319,23 +354,28 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, long) Unix timestamp at which the event happened", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(required, string) Error code from WhatsApp", "provider_error_title" : "(required, string) Description of error from WhatsApp", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, long) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -349,16 +389,21 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(required, string) Error code from WhatsApp", "provider_error_title" : "(required, string) Description of error from WhatsApp", "subscription_group_id" : "(optional, string) Subscription group API ID", @@ -382,24 +427,29 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(required, string) Error code from WhatsApp", - "provider_error_title" : "(required, string) Description of error from WhatsApp" + "provider_error_title" : "(required, string) Description of error from WhatsApp", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -429,18 +479,23 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(required, string) Error code from WhatsApp", - "provider_error_title" : "(required, string) Description of error from WhatsApp" + "provider_error_title" : "(required, string) Description of error from WhatsApp", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -465,18 +520,23 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(required, string) Error code from WhatsApp", - "provider_error_title" : "(required, string) Description of error from WhatsApp" + "provider_error_title" : "(required, string) Description of error from WhatsApp", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, long) Unix timestamp at which the event happened", "type" : "track", @@ -507,25 +567,30 @@ This event occurs when a send request was successfully communicated between Braz "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, long) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -538,22 +603,27 @@ This event occurs when a send request was successfully communicated between Braz { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, long) Unix timestamp at which the event happened", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "$insert_id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, long) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -567,9 +637,12 @@ This event occurs when a send request was successfully communicated between Braz { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", @@ -578,6 +651,7 @@ This event occurs when a send request was successfully communicated between Braz "id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, long) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -599,23 +673,28 @@ This event occurs when a send request was successfully communicated between Braz "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -645,17 +724,22 @@ This event occurs when a send request was successfully communicated between Braz { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -680,17 +764,22 @@ This event occurs when a send request was successfully communicated between Braz "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, long) Unix timestamp at which the event happened", "type" : "track", @@ -721,25 +810,30 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, long) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -752,22 +846,27 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, long) Unix timestamp at which the event happened", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, long) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -783,15 +882,20 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, long) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -813,23 +917,28 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -859,17 +968,22 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -894,17 +1008,22 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, long) Unix timestamp at which the event happened", "type" : "track", @@ -934,27 +1053,32 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "user_phone_number" : "(required, string) The user's phone number from which the message was received", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", - "media_urls" : "(optional, array of string) Media URLs from the user", - "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "subscription_group_id" : "(optional, string) Subscription group API ID", + "user_phone_number" : "(required, string) The user's phone number from which the message was received" }, "time" : "(required, long) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -967,25 +1091,30 @@ This event occurs when one of your users sends a WhatsApp message to a phone num { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, long) Unix timestamp at which the event happened", - "user_phone_number" : "(required, string) The user's phone number from which the message was received", - "distinct_id" : "(required, string) External ID of the user", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", + "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", - "media_urls" : "(optional, array of string) Media URLs from the user", - "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "token" : "(required, string) The Mixpanel API token" + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, long) Unix timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token", + "user_phone_number" : "(required, string) The user's phone number from which the message was received" } } ``` @@ -999,10 +1128,14 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", @@ -1010,6 +1143,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, long) Unix timestamp at which the event happened", @@ -1032,24 +1166,29 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened", "custom_attributes" : { - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", - "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None)." + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1079,19 +1218,24 @@ This event occurs when one of your users sends a WhatsApp message to a phone num { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "user_phone_number" : "(required, string) The user's phone number from which the message was received", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", - "media_urls" : "(optional, array of string) Media URLs from the user", - "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None)." + "subscription_group_id" : "(optional, string) Subscription group API ID", + "user_phone_number" : "(required, string) The user's phone number from which the message was received" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -1116,19 +1260,24 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", - "media_urls" : "(optional, array of string) Media URLs from the user", - "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None)." + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, long) Unix timestamp at which the event happened", "type" : "track", @@ -1159,24 +1308,29 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -1189,21 +1343,26 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1219,15 +1378,20 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -1248,23 +1412,28 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1292,16 +1461,21 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -1324,17 +1498,22 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -1365,26 +1544,31 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -1397,23 +1581,28 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1429,10 +1618,14 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", @@ -1440,6 +1633,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -1460,24 +1654,29 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1492,8 +1691,8 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -1506,18 +1705,23 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -1542,18 +1746,23 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -1584,26 +1793,31 @@ This event occurs if a push notification message was aborted based on Liquid abo "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -1616,23 +1830,28 @@ This event occurs if a push notification message was aborted based on Liquid abo { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1649,15 +1868,20 @@ This event occurs if a push notification message was aborted based on Liquid abo "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", @@ -1680,24 +1904,29 @@ This event occurs if a push notification message was aborted based on Liquid abo "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1725,18 +1954,23 @@ This event occurs if a push notification message was aborted based on Liquid abo { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -1761,19 +1995,24 @@ This event occurs if a push notification message was aborted based on Liquid abo "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -1804,21 +2043,26 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user" + "external_user_id" : "(required, string) External ID of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -1831,19 +2075,24 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", + "$partner_id" : "braze", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1859,13 +2108,18 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, int) Unix timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -1883,21 +2137,26 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1924,15 +2183,20 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho { "event_properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -1955,15 +2219,20 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -1994,24 +2263,29 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -2024,21 +2298,26 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2054,15 +2333,20 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -2083,23 +2367,28 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2127,16 +2416,21 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -2159,17 +2453,22 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)", + "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "abort_type" : "(optional, string) Type of abort, one of ['liquid_abort_message', 'quiet_hours', 'rate_limit']", - "abort_log" : "(optional, string) Log message describing abort details (up to 128 chars)" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -2202,14 +2501,17 @@ This event occurs when a user has exited a Canvas by performing an event. "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(optional, string) ID of the card this in app message comes from" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user" + "external_user_id" : "(required, string) External ID of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -2222,14 +2524,17 @@ This event occurs when a user has exited a Canvas by performing an event. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2245,10 +2550,13 @@ This event occurs when a user has exited a Canvas by performing an event. "app_group_id" : "(required, string) API ID of the app group this user belongs to", "canvas_api_id" : "(optional, string) [DEPRECATED]", "canvas_id" : "(required, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_api_id" : "(optional, string) [DEPRECATED]", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_api_id" : "(optional, string) [DEPRECATED]", "canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) Unix timestamp at which the event happened", @@ -2267,16 +2575,19 @@ This event occurs when a user has exited a Canvas by performing an event. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2305,8 +2616,11 @@ This event occurs when a user has exited a Canvas by performing an event. "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -2331,8 +2645,11 @@ This event occurs when a user has exited a Canvas by performing an event. "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -2365,14 +2682,17 @@ This event occurs when a user has exited a Canvas by matching an audience. "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(optional, string) ID of the card this in app message comes from" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user" + "external_user_id" : "(required, string) External ID of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -2385,14 +2705,17 @@ This event occurs when a user has exited a Canvas by matching an audience. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2408,10 +2731,13 @@ This event occurs when a user has exited a Canvas by matching an audience. "app_group_id" : "(required, string) API ID of the app group this user belongs to", "canvas_api_id" : "(optional, string) [DEPRECATED]", "canvas_id" : "(required, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_api_id" : "(optional, string) [DEPRECATED]", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_api_id" : "(optional, string) [DEPRECATED]", "canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) Unix timestamp at which the event happened", @@ -2430,16 +2756,19 @@ This event occurs when a user has exited a Canvas by matching an audience. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2468,8 +2797,11 @@ This event occurs when a user has exited a Canvas by matching an audience. "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -2494,8 +2826,11 @@ This event occurs when a user has exited a Canvas by matching an audience. "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -2526,17 +2861,21 @@ This event occurs when a user enters a Canvas experiment step path. "id" : "(required, string) Globally unique ID for this event", "properties" : { "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", - "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user" + "external_user_id" : "(required, string) External ID of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -2549,16 +2888,20 @@ This event occurs when a user enters a Canvas experiment step path. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2571,9 +2914,13 @@ This event occurs when a user enters a Canvas experiment step path. { "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", @@ -2594,18 +2941,22 @@ This event occurs when a user enters a Canvas experiment step path. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_attributes" : { "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2633,9 +2984,13 @@ This event occurs when a user enters a Canvas experiment step path. { "event_properties" : { "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, @@ -2661,9 +3016,13 @@ This event occurs when a user enters a Canvas experiment step path. "messageId" : "(required, string) Globally unique ID for this event", "properties" : { "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, @@ -2698,17 +3057,22 @@ This event occurs when a user convert for a Canvas experiment step. "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", - "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", + "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user" + "external_user_id" : "(required, string) External ID of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -2721,17 +3085,22 @@ This event occurs when a user convert for a Canvas experiment step. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", - "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", + "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2745,10 +3114,15 @@ This event occurs when a user convert for a Canvas experiment step. { "app_id" : "(optional, string) API ID of the app on which this event occurred", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", + "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", @@ -2768,18 +3142,23 @@ This event occurs when a user convert for a Canvas experiment step. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_attributes" : { "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "experiment_split_name" : "(optional, string) Name of the experiment split", + "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to" }, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2808,11 +3187,16 @@ This event occurs when a user convert for a Canvas experiment step. "event_properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "experiment_split_name" : "(optional, string) Name of the experiment split", + "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -2837,11 +3221,16 @@ This event occurs when a user convert for a Canvas experiment step. "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "experiment_split_name" : "(optional, string) Name of the experiment split", + "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -2872,28 +3261,33 @@ This event occurs when Braze processes a push message for a user, communicating "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -2906,25 +3300,30 @@ This event occurs when Braze processes a push message for a user, communicating { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2941,15 +3340,20 @@ This event occurs when Braze processes a push message for a user, communicating "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", @@ -2965,35 +3369,40 @@ This event occurs when Braze processes a push message for a user, communicating { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3022,20 +3431,25 @@ This event occurs when Braze processes a push message for a user, communicating "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -3061,21 +3475,26 @@ This event occurs when Braze processes a push message for a user, communicating "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -3109,31 +3528,36 @@ This event occurs when a user directly clicks on the Push notification to open t "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "button_action_type" : "(optional, string) Action type of the push notification button, null if not from a button click. One of ['uri', 'deep_link', 'none', 'close']", + "button_string" : "(optional, string) Identifier (button_string) of the push notification button clicked. null if not from a button click", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_model" : "(optional, string) Model of the device", - "button_string" : "(optional, string) Identifier (button_string) of the push notification button clicked. null if not from a button click", - "button_action_type" : "(optional, string) Action type of the push notification button, null if not from a button click. One of ['uri', 'deep_link', 'none', 'close']", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -3146,26 +3570,31 @@ This event occurs when a user directly clicks on the Push notification to open t { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3184,16 +3613,21 @@ This event occurs when a user directly clicks on the Push notification to open t "button_action_type" : "(optional, string) Action type of the push notification button, null if not from a button click. One of ['uri', 'deep_link', 'none', 'close']", "button_string" : "(optional, string) Identifier (button_string) of the push notification button clicked. null if not from a button click", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", "canvas_step_message_variation_id" : "(optional, string) API ID of the Canvas step message variation this user received", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", @@ -3210,35 +3644,40 @@ This event occurs when a user directly clicks on the Push notification to open t { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "device_model" : "(optional, string) Model of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3267,21 +3706,26 @@ This event occurs when a user directly clicks on the Push notification to open t "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -3301,27 +3745,32 @@ This event occurs when a user directly clicks on the Push notification to open t "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -3354,29 +3803,34 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -3389,26 +3843,31 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3425,14 +3884,19 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", @@ -3450,21 +3914,26 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -3484,27 +3953,32 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -3537,27 +4011,32 @@ This event occurs when an error is received from either Apple Push Notification "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -3570,24 +4049,29 @@ This event occurs when an error is received from either Apple Push Notification { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3604,14 +4088,19 @@ This event occurs when an error is received from either Apple Push Notification "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_id" : "(optional, string) ID of the device on which the event occurred", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", @@ -3627,34 +4116,39 @@ This event occurs when an error is received from either Apple Push Notification { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3683,19 +4177,24 @@ This event occurs when an error is received from either Apple Push Notification "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -3721,20 +4220,25 @@ This event occurs when an error is received from either Apple Push Notification "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -3767,24 +4271,29 @@ This event occurs when an email send request was successfully communicated betwe "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -3797,22 +4306,27 @@ This event occurs when an email send request was successfully communicated betwe { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3825,9 +4339,13 @@ This event occurs when an email send request was successfully communicated betwe { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "external_user_id" : "(optional, string) External ID of the user", @@ -3835,6 +4353,7 @@ This event occurs when an email send request was successfully communicated betwe "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -3855,25 +4374,30 @@ This event occurs when an email send request was successfully communicated betwe "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "from_domain" : "(optional, string) Sending domain for the email", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3888,8 +4412,8 @@ This event occurs when an email send request was successfully communicated betwe "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -3903,16 +4427,21 @@ This event occurs when an email send request was successfully communicated betwe "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -3937,19 +4466,24 @@ This event occurs when an email send request was successfully communicated betwe "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "from_domain" : "(optional, string) Sending domain for the email", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -3986,26 +4520,31 @@ This event occurs when an email sent made it successfully to the end-users inbox "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "sending_ip" : "(optional, string) IP address from which the email send was made", - "ip_pool" : "(optional, string) IP pool from which the email send was made", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "sending_ip" : "(optional, string) IP address from which the email send was made" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -4018,23 +4557,28 @@ This event occurs when an email sent made it successfully to the end-users inbox { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "distinct_id" : "(required, string) External ID of the user", "from_domain" : "(optional, string) Sending domain for the email", + "$insert_id" : "(required, string) Globally unique ID for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -4047,9 +4591,13 @@ This event occurs when an email sent made it successfully to the end-users inbox { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -4058,6 +4606,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made", "time" : "(required, int) Unix timestamp at which the event happened", @@ -4079,24 +4628,29 @@ This event occurs when an email sent made it successfully to the end-users inbox "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4111,8 +4665,8 @@ This event occurs when an email sent made it successfully to the end-users inbox "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -4126,17 +4680,22 @@ This event occurs when an email sent made it successfully to the end-users inbox "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -4161,18 +4720,23 @@ This event occurs when an email sent made it successfully to the end-users inbox "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -4207,33 +4771,38 @@ This event occurs when a user opens an email. Multiple events may be generated f "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "email_address" : "(required, string) Email address of the user", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", - "device_os" : "(optional, string) Device operating system extracted from user_agent", "device_model" : "(optional, string) Model of the device", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", + "device_os" : "(optional, string) Device operating system extracted from user_agent", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_amp" : "(optional, boolean) Indicates that this is an AMP event", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", + "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -4246,32 +4815,37 @@ This event occurs when a user opens an email. Multiple events may be generated f { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "email_address" : "(required, string) Email address of the user", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", - "device_os" : "(optional, string) Device operating system extracted from user_agent", + "device_id" : "(optional, string) ID of the device on which the event occurred", "$device" : "(optional, string) Model of the device", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", + "device_os" : "(optional, string) Device operating system extracted from user_agent", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "distinct_id" : "(required, string) External ID of the user", "from_domain" : "(optional, string) Sending domain for the email", + "$insert_id" : "(required, string) Globally unique ID for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_amp" : "(optional, boolean) Indicates that this is an AMP event", - "token" : "(required, string) The Mixpanel API token" + "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", + "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token", + "user_agent" : "(optional, string) User agent on which the spam report occurred" } } ``` @@ -4284,9 +4858,13 @@ This event occurs when a user opens an email. Multiple events may be generated f { "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", "device_model" : "(optional, string) Model of the device", "device_os" : "(optional, string) Device operating system extracted from user_agent", @@ -4301,6 +4879,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -4323,31 +4902,36 @@ This event occurs when a user opens an email. Multiple events may be generated f "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", + "device_id" : "(optional, string) ID of the device on which the event occurred", "device_os" : "(optional, string) Device operating system extracted from user_agent", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "from_domain" : "(optional, string) Sending domain for the email", "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_amp" : "(optional, boolean) Indicates that this is an AMP event", "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", - "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", - "from_domain" : "(optional, string) Sending domain for the email", - "is_amp" : "(optional, boolean) Indicates that this is an AMP event" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4362,8 +4946,8 @@ This event occurs when a user opens an email. Multiple events may be generated f "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -4377,25 +4961,30 @@ This event occurs when a user opens an email. Multiple events may be generated f "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "email_address" : "(required, string) Email address of the user", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", - "device_os" : "(optional, string) Device operating system extracted from user_agent", "device_model" : "(optional, string) Model of the device", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "device_os" : "(optional, string) Device operating system extracted from user_agent", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "email_address" : "(required, string) Email address of the user", + "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "from_domain" : "(optional, string) Sending domain for the email", "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_amp" : "(optional, boolean) Indicates that this is an AMP event", "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", - "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", - "from_domain" : "(optional, string) Sending domain for the email", - "is_amp" : "(optional, boolean) Indicates that this is an AMP event" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -4422,25 +5011,30 @@ This event occurs when a user opens an email. Multiple events may be generated f "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", + "device_id" : "(optional, string) ID of the device on which the event occurred", "device_os" : "(optional, string) Device operating system extracted from user_agent", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "from_domain" : "(optional, string) Sending domain for the email", "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_amp" : "(optional, boolean) Indicates that this is an AMP event", "machine_open" : "(optional, string) Populated to 'true' if the open event is triggered without user engagement, for example by an Apple device with Mail Privacy Protection enabled. Value may change over time to provide more granularity.", - "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", - "from_domain" : "(optional, string) Sending domain for the email", - "is_amp" : "(optional, boolean) Indicates that this is an AMP event" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -4475,35 +5069,40 @@ This event occurs when a user clicks an email. Multiple events may be generated "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "email_address" : "(required, string) Email address of the user", - "url" : "(optional, string) URL that the user clicked on", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", - "device_os" : "(optional, string) Device operating system extracted from user_agent", "device_model" : "(optional, string) Model of the device", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", - "link_alias" : "(optional, string) Alias associated with this link ID", + "device_os" : "(optional, string) Device operating system extracted from user_agent", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_amp" : "(optional, boolean) Indicates that this is an AMP event", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "link_alias" : "(optional, string) Alias associated with this link ID", + "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", + "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "url" : "(optional, string) URL that the user clicked on", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -4516,34 +5115,39 @@ This event occurs when a user clicks an email. Multiple events may be generated { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "email_address" : "(required, string) Email address of the user", - "url" : "(optional, string) URL that the user clicked on", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", - "device_os" : "(optional, string) Device operating system extracted from user_agent", + "device_id" : "(optional, string) ID of the device on which the event occurred", "$device" : "(optional, string) Model of the device", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", - "link_alias" : "(optional, string) Alias associated with this link ID", + "device_os" : "(optional, string) Device operating system extracted from user_agent", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "distinct_id" : "(required, string) External ID of the user", "from_domain" : "(optional, string) Sending domain for the email", - "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "$insert_id" : "(required, string) Globally unique ID for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_amp" : "(optional, boolean) Indicates that this is an AMP event", - "token" : "(required, string) The Mixpanel API token" + "link_alias" : "(optional, string) Alias associated with this link ID", + "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", + "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token", + "url" : "(optional, string) URL that the user clicked on", + "user_agent" : "(optional, string) User agent on which the spam report occurred" } } ``` @@ -4556,9 +5160,13 @@ This event occurs when a user clicks an email. Multiple events may be generated { "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", "device_model" : "(optional, string) Model of the device", "device_os" : "(optional, string) Device operating system extracted from user_agent", @@ -4574,6 +5182,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -4597,33 +5206,38 @@ This event occurs when a user clicks an email. Multiple events may be generated "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "url" : "(optional, string) URL that the user clicked on", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", + "device_id" : "(optional, string) ID of the device on which the event occurred", "device_os" : "(optional, string) Device operating system extracted from user_agent", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", - "link_alias" : "(optional, string) Alias associated with this link ID", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_amp" : "(optional, boolean) Indicates that this is an AMP event", + "link_alias" : "(optional, string) Alias associated with this link ID", + "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", - "is_amp" : "(optional, boolean) Indicates that this is an AMP event" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "url" : "(optional, string) URL that the user clicked on", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4638,8 +5252,8 @@ This event occurs when a user clicks an email. Multiple events may be generated "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -4653,27 +5267,32 @@ This event occurs when a user clicks an email. Multiple events may be generated "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "email_address" : "(required, string) Email address of the user", - "url" : "(optional, string) URL that the user clicked on", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", - "device_os" : "(optional, string) Device operating system extracted from user_agent", "device_model" : "(optional, string) Model of the device", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", - "link_alias" : "(optional, string) Alias associated with this link ID", + "device_os" : "(optional, string) Device operating system extracted from user_agent", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_amp" : "(optional, boolean) Indicates that this is an AMP event", + "link_alias" : "(optional, string) Alias associated with this link ID", + "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", - "is_amp" : "(optional, boolean) Indicates that this is an AMP event" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "url" : "(optional, string) URL that the user clicked on", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -4700,28 +5319,33 @@ This event occurs when a user clicks an email. Multiple events may be generated "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "url" : "(optional, string) URL that the user clicked on", - "link_url" : "(optional, string) URL that the user clicked on", - "user_agent" : "(optional, string) User agent on which the spam report occurred", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", + "device_id" : "(optional, string) ID of the device on which the event occurred", "device_os" : "(optional, string) Device operating system extracted from user_agent", - "browser" : "(optional, string) Device browser - extracted from user_agent - on which the open occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", - "link_alias" : "(optional, string) Alias associated with this link ID", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_amp" : "(optional, boolean) Indicates that this is an AMP event", + "link_alias" : "(optional, string) Alias associated with this link ID", + "link_id" : "(optional, string) Unique ID for the link which was clicked, as created by Braze", "mailbox_provider" : "(optional, string) Mailbox provider value returned by the esp for this event", - "is_amp" : "(optional, boolean) Indicates that this is an AMP event" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "url" : "(optional, string) URL that the user clicked on", + "link_url" : "(optional, string) URL that the user clicked on", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -4756,28 +5380,33 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "sending_ip" : "(optional, string) IP address from which the email send was made", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "sending_ip" : "(optional, string) IP address from which the email send was made" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -4790,25 +5419,30 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "distinct_id" : "(required, string) External ID of the user", "from_domain" : "(optional, string) Sending domain for the email", + "$insert_id" : "(required, string) Globally unique ID for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -4822,9 +5456,13 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har { "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -4834,6 +5472,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "ip_pool" : "(optional, string) IP pool from which the email send was made", "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made", "time" : "(required, int) Unix timestamp at which the event happened", @@ -4855,26 +5494,31 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4889,8 +5533,8 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -4904,19 +5548,24 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -4941,20 +5590,25 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "is_drop" : "(optional, boolean) Indicates that this event counts as a drop event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -4989,27 +5643,32 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "sending_ip" : "(optional, string) IP address from which the email send was made", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "sending_ip" : "(optional, string) IP address from which the email send was made" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -5022,24 +5681,29 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "distinct_id" : "(required, string) External ID of the user", "from_domain" : "(optional, string) Sending domain for the email", + "$insert_id" : "(required, string) Globally unique ID for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -5053,9 +5717,13 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof { "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -5064,6 +5732,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made", "time" : "(required, int) Unix timestamp at which the event happened", @@ -5085,25 +5754,30 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5118,8 +5792,8 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -5133,18 +5807,23 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -5169,19 +5848,24 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made", - "bounce_reason" : "(optional, string) The SMTP reason code and user friendly message received for this bounce event", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -5216,26 +5900,31 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "user_agent" : "(optional, string) User agent on which the spam report occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", "from_domain" : "(optional, string) Sending domain for the email", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -5248,25 +5937,30 @@ This event occurs when the end-user hits the "spam" button on the email. Note th { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "user_agent" : "(optional, string) User agent on which the spam report occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", + "distinct_id" : "(required, string) External ID of the user", "from_domain" : "(optional, string) Sending domain for the email", - "token" : "(required, string) The Mixpanel API token" + "$insert_id" : "(required, string) Globally unique ID for this event", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token", + "user_agent" : "(optional, string) User agent on which the spam report occurred" } } ``` @@ -5278,9 +5972,13 @@ This event occurs when the end-user hits the "spam" button on the email. Note th { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -5289,6 +5987,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -5310,25 +6009,30 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "user_agent" : "(optional, string) User agent on which the spam report occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5343,8 +6047,8 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -5358,18 +6062,23 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "user_agent" : "(optional, string) User agent on which the spam report occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -5394,19 +6103,24 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "user_agent" : "(optional, string) User agent on which the spam report occurred", - "ip_pool" : "(optional, string) IP pool from which the email send was made", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", - "from_domain" : "(optional, string) Sending domain for the email" + "from_domain" : "(optional, string) Sending domain for the email", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -5446,23 +6160,28 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -5475,21 +6194,26 @@ The `Unsubscribe` event is actually a specialized click event that is fired when { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -5502,15 +6226,20 @@ The `Unsubscribe` event is actually a specialized click event that is fired when { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "ip_pool" : "(optional, string) IP pool from which the email send was made", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -5531,22 +6260,27 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5561,8 +6295,8 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(required, string) Email address of the user" + "email" : "(required, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -5576,15 +6310,20 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", - "ip_pool" : "(optional, string) IP pool from which the email send was made" + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -5609,16 +6348,21 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "ip_pool" : "(optional, string) IP pool from which the email send was made" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "ip_pool" : "(optional, string) IP pool from which the email send was made", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -5652,30 +6396,35 @@ This event occurs when a user views an in-app message. "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -5688,28 +6437,33 @@ This event occurs when a user views an in-app message. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -5726,9 +6480,13 @@ This event occurs when a user views an in-app message. "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", "device_model" : "(optional, string) Model of the device", @@ -5736,6 +6494,7 @@ This event occurs when a user views an in-app message. "id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", @@ -5752,37 +6511,42 @@ This event occurs when a user views an in-app message. { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "device_model" : "(optional, string) Model of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5811,23 +6575,28 @@ This event occurs when a user views an in-app message. "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -5847,29 +6616,34 @@ This event occurs when a user views an in-app message. "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -5907,30 +6681,35 @@ This event occurs when a user clicks on an in-app message. "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "device_model" : "(optional, string) Model of the device", - "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -5943,28 +6722,33 @@ This event occurs when a user clicks on an in-app message. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -5982,15 +6766,20 @@ This event occurs when a user clicks on an in-app message. "app_id" : "(required, string) API ID of the app on which this event occurred", "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", "device_model" : "(optional, string) Model of the device", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", @@ -6007,37 +6796,42 @@ This event occurs when a user clicks on an in-app message. { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "device_model" : "(optional, string) Model of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", - "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6066,23 +6860,28 @@ This event occurs when a user clicks on an in-app message. "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_model" : "(optional, string) Model of the device", - "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -6102,29 +6901,34 @@ This event occurs when a user clicks on an in-app message. "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "card_id" : "(optional, string) API ID of the card", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) API ID of the card", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "button_id" : "(optional, string) ID of the button clicked, if this click represents a click on a button", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -6160,22 +6964,27 @@ This event occurs when a webhook was processed and sent to the third party speci "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -6188,20 +6997,25 @@ This event occurs when a webhook was processed and sent to the third party speci { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6214,13 +7028,18 @@ This event occurs when a webhook was processed and sent to the third party speci { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -6241,22 +7060,27 @@ This event occurs when a webhook was processed and sent to the third party speci "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6285,14 +7109,19 @@ This event occurs when a webhook was processed and sent to the third party speci "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -6315,16 +7144,21 @@ This event occurs when a webhook was processed and sent to the third party speci "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -6359,23 +7193,28 @@ This event occurs when a Content Card gets sent to a user. "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "content_card_id" : "(required, string) ID of the card that generated this event", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -6388,21 +7227,26 @@ This event occurs when a Content Card gets sent to a user. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(required, string) ID of the card that generated this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6415,15 +7259,20 @@ This event occurs when a Content Card gets sent to a user. { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "content_card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -6444,23 +7293,28 @@ This event occurs when a Content Card gets sent to a user. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(required, string) ID of the card that generated this event", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6489,15 +7343,20 @@ This event occurs when a Content Card gets sent to a user. "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(required, string) ID of the card that generated this event", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -6520,17 +7379,22 @@ This event occurs when a Content Card gets sent to a user. "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "card_id" : "(required, string) ID of the card that generated this event", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -6563,30 +7427,35 @@ This event occurs when a user views a Content Card. "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "content_card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "content_card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -6599,27 +7468,32 @@ This event occurs when a user views a Content Card. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "card_id" : "(required, string) ID of the card that generated this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6636,15 +7510,20 @@ This event occurs when a user views a Content Card. "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "content_card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", "device_model" : "(optional, string) Model of the device", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", @@ -6661,36 +7540,41 @@ This event occurs when a user views a Content Card. { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "device_model" : "(optional, string) Model of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6719,22 +7603,27 @@ This event occurs when a user views a Content Card. "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -6754,28 +7643,33 @@ This event occurs when a user views a Content Card. "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -6808,30 +7702,35 @@ This event occurs when a user clicks a Content Card. "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "content_card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "content_card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -6844,27 +7743,32 @@ This event occurs when a user clicks a Content Card. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "card_id" : "(required, string) ID of the card that generated this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6881,15 +7785,20 @@ This event occurs when a user clicks a Content Card. "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "content_card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", "device_model" : "(optional, string) Model of the device", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", @@ -6906,36 +7815,41 @@ This event occurs when a user clicks a Content Card. { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "device_model" : "(optional, string) Model of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6964,22 +7878,27 @@ This event occurs when a user clicks a Content Card. "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -6999,28 +7918,33 @@ This event occurs when a user clicks a Content Card. "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -7054,30 +7978,35 @@ This event occurs when a user dismisses a Content Card. "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "content_card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "content_card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -7090,27 +8019,32 @@ This event occurs when a user dismisses a Content Card. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "card_id" : "(required, string) ID of the card that generated this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "$os" : "(optional, string) Version of the operating system of the device", "$device" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "$os" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -7127,15 +8061,20 @@ This event occurs when a user dismisses a Content Card. "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(required, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "content_card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", "device_model" : "(optional, string) Model of the device", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", @@ -7152,36 +8091,41 @@ This event occurs when a user dismisses a Content Card. { "device_info" : { - "ios_idfv" : "(optional, string) ID of the device on which the event occurred", - "platform" : "(optional, string) Platform of the device", - "device_model" : "(optional, string) Model of the device", "ios_advertising_id" : "(optional, string) Advertising identifier", "android_advertising_id" : "(optional, string) Advertising identifier", "microsoft_advertising_id" : "(optional, string) Advertising identifier", "roku_advertising_id" : "(optional, string) Advertising identifier", - "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "limit_ad_tracking" : "(optional, boolean) Whether advertising tracking is enabled for the device", + "ios_idfv" : "(optional, string) ID of the device on which the event occurred", + "device_model" : "(optional, string) Model of the device", + "platform" : "(optional, string) Platform of the device" }, "environment" : "(required, string) The mParticle environment (either 'development' or 'production')", "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7210,22 +8154,27 @@ This event occurs when a user dismisses a Content Card. "adid" : "(optional, string) Advertising identifier", "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "platform" : "(optional, string) Platform of the device", - "os_version" : "(optional, string) Version of the operating system of the device", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "os_version" : "(optional, string) Version of the operating system of the device", + "platform" : "(optional, string) Platform of the device", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "idfa" : "(optional, string) Advertising identifier", @@ -7245,28 +8194,33 @@ This event occurs when a user dismisses a Content Card. "context" : { "traits" : { }, "device" : { - "type" : "(optional, string) Platform of the device", - "model" : "(optional, string) Model of the device" + "model" : "(optional, string) Model of the device", + "type" : "(optional, string) Platform of the device" } }, "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "card_id" : "(required, string) ID of the card that generated this event", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "ad_id" : "(optional, string) Advertising identifier", + "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", + "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(required, string) ID of the card that generated this event", "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", - "ad_id" : "(optional, string) Advertising identifier", - "ad_id_type" : "(optional, string) One of ['ios_idfa', 'google_ad_id', 'windows_ad_id', 'roku_ad_id']", - "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device" + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -7303,22 +8257,27 @@ This event occurs when a user clicks an SMS short link. "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "url" : "(optional, string) URL that the user clicked on", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", + "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", - "user_phone_number" : "(optional, string) The user's phone number from which the message was received", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "user_phone_number" : "(optional, string) The user's phone number from which the message was received" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -7331,22 +8290,27 @@ This event occurs when a user clicks an SMS short link. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "url" : "(optional, string) URL that the user clicked on", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", + "time" : "(required, int) Unix timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token", + "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", - "user_phone_number" : "(optional, string) The user's phone number from which the message was received", - "token" : "(required, string) The Mixpanel API token" + "user_phone_number" : "(optional, string) The user's phone number from which the message was received" } } ``` @@ -7359,12 +8323,17 @@ This event occurs when a user clicks an SMS short link. { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -7388,22 +8357,27 @@ This event occurs when a user clicks an SMS short link. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "url" : "(optional, string) URL that the user clicked on", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", + "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7435,12 +8409,17 @@ This event occurs when a user clicks an SMS short link. "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "url" : "(optional, string) URL that the user clicked on", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", + "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", "user_phone_number" : "(optional, string) The user's phone number from which the message was received" }, @@ -7467,16 +8446,21 @@ This event occurs when a user clicks an SMS short link. "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "short_url" : "(required, string) Shortened url that was clicked", "url" : "(optional, string) URL that the user clicked on", "link_url" : "(optional, string) URL that the user clicked on", - "short_url" : "(required, string) Shortened url that was clicked", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", @@ -7507,25 +8491,30 @@ This event occurs when a user sends an SMS. "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -7538,23 +8527,28 @@ This event occurs when a user sends an SMS. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "time" : "(required, int) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -7567,15 +8561,20 @@ This event occurs when a user sends an SMS. { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, int) Unix timestamp at which the event happened", @@ -7598,24 +8597,29 @@ This event occurs when a user sends an SMS. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7646,17 +8650,22 @@ This event occurs when a user sends an SMS. "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -7681,18 +8690,23 @@ This event occurs when a user sends an SMS. "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", - "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering" + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -7731,24 +8745,29 @@ This event occurs when an SMS is sent to the carrier. "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -7761,22 +8780,27 @@ This event occurs when an SMS is sent to the carrier. { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, int) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -7789,14 +8813,19 @@ This event occurs when an SMS is sent to the carrier. { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, int) Unix timestamp at which the event happened", @@ -7819,23 +8848,28 @@ This event occurs when an SMS is sent to the carrier. "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7866,16 +8900,21 @@ This event occurs when an SMS is sent to the carrier. "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -7900,16 +8939,21 @@ This event occurs when an SMS is sent to the carrier. "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", @@ -7942,24 +8986,29 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -7972,22 +9021,27 @@ This event occurs when an SMS was successfully delivered to the users mobile pho { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, int) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -8000,14 +9054,19 @@ This event occurs when an SMS was successfully delivered to the users mobile pho { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "external_user_id" : "(optional, string) External ID of the user", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, int) Unix timestamp at which the event happened", @@ -8030,23 +9089,28 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8077,16 +9141,21 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -8111,16 +9180,21 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", @@ -8153,26 +9227,31 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", + "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(optional, string) Error code from WhatsApp", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -8185,24 +9264,29 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", + "distinct_id" : "(required, string) External ID of the user", + "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, int) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -8215,15 +9299,20 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", "external_user_id" : "(optional, string) External ID of the user", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(optional, string) Error code from WhatsApp", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", @@ -8247,25 +9336,30 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", - "provider_error_code" : "(optional, string) Error code from WhatsApp" + "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8296,18 +9390,23 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "error" : "(optional, string) Error name", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "error" : "(optional, string) Error name", - "provider_error_code" : "(optional, string) Error code from WhatsApp" + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -8332,19 +9431,24 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", - "provider_error_code" : "(optional, string) Error code from WhatsApp" + "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -8377,25 +9481,30 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(optional, string) Error code from WhatsApp", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -8408,23 +9517,28 @@ This event occurs when an SMS experiences delivery failure. Use this event and t { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, int) Unix timestamp at which the event happened", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } } @@ -8437,14 +9551,19 @@ This event occurs when an SMS experiences delivery failure. Use this event and t { "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "provider_error_code" : "(optional, string) Error code from WhatsApp", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", @@ -8468,24 +9587,29 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", - "provider_error_code" : "(optional, string) Error code from WhatsApp" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8516,17 +9640,22 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", - "provider_error_code" : "(optional, string) Error code from WhatsApp" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -8551,18 +9680,23 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", - "provider_error_code" : "(optional, string) Error code from WhatsApp" + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "provider_error_code" : "(optional, string) Error code from WhatsApp", + "send_id" : "(optional, string) Message send ID this message belongs to", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -8596,24 +9730,29 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "user_phone_number" : "(required, string) The user's phone number from which the message was received", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "message_body" : "(optional, string) Typed response from the user", - "media_urls" : "(optional, array of string) Media URLs from the user", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", + "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "user_phone_number" : "(required, string) The user's phone number from which the message was received" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user" + "external_user_id" : "(required, string) External ID of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -8626,23 +9765,28 @@ If we detect that this inbound message is a reply to an outbound campaign or Can { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", - "user_phone_number" : "(required, string) The user's phone number from which the message was received", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "$partner_id" : "braze", "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "message_body" : "(optional, string) Typed response from the user", - "media_urls" : "(optional, array of string) Media URLs from the user", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "token" : "(required, string) The Mixpanel API token" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", + "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "time" : "(required, int) Unix timestamp at which the event happened", + "token" : "(required, string) The Mixpanel API token", + "user_phone_number" : "(required, string) The user's phone number from which the message was received" } } ``` @@ -8656,16 +9800,21 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", "app_group_id" : "(required, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(required, string) Typed response from the user", "message_variation_id" : "(optional, string) API ID of the message variation this user received", - "subscription_group_id" : "(optional, string) Subscription group API ID", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) BSON ID of subscription group", "time" : "(required, int) Unix timestamp at which the event happened", "user_id" : "(optional, string) BSON ID of the user who performed this event", "user_phone_number" : "(required, string) The user's phone number from which the message was received" @@ -8683,22 +9832,27 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "message_body" : "(optional, string) Typed response from the user", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8727,18 +9881,23 @@ If we detect that this inbound message is a reply to an outbound campaign or Can { "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "user_phone_number" : "(required, string) The user's phone number from which the message was received", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "message_body" : "(optional, string) Typed response from the user", - "media_urls" : "(optional, array of string) Media URLs from the user", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", + "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID", + "user_phone_number" : "(required, string) The user's phone number from which the message was received" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -8763,17 +9922,22 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "subscription_group_id" : "(optional, string) Subscription group API ID", - "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "action" : "(required, string) Action taken in response to this message. (for example Subscribed, Unsubscribed or None).", - "message_body" : "(optional, string) Typed response from the user", - "media_urls" : "(optional, array of string) Media URLs from the user", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", + "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", - "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to" + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", + "media_urls" : "(optional, array of string) Media URLs from the user", + "message_body" : "(optional, string) Typed response from the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "subscription_group_id" : "(optional, string) Subscription group API ID" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -8809,21 +9973,24 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -8836,18 +10003,21 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -8861,10 +10031,13 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh { "app_id" : "(optional, string) API ID of the app on which this event occurred", "campaign_id" : "(required, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -8885,19 +10058,22 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8925,13 +10101,16 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -8954,14 +10133,17 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -8997,20 +10179,24 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -9023,17 +10209,21 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -9047,8 +10237,12 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh { "app_id" : "(optional, string) API ID of the app on which this event occurred", "canvas_id" : "(required, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", @@ -9071,18 +10265,22 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "device_id" : "(optional, string) ID of the device on which the event occurred" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9110,11 +10308,15 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", @@ -9138,13 +10340,17 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", + "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", + "device_id" : "(optional, string) ID of the device on which the event occurred" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -9178,17 +10384,20 @@ This event occurs when a user enters into the Canvas. This event tells you which "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -9201,16 +10410,19 @@ This event occurs when a user enters into the Canvas. This event tells you which { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", + "$partner_id" : "braze", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -9223,8 +10435,11 @@ This event occurs when a user enters into the Canvas. This event tells you which { "canvas_id" : "(required, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(required, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", @@ -9247,18 +10462,21 @@ This event occurs when a user enters into the Canvas. This event tells you which "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9288,8 +10506,11 @@ This event occurs when a user enters into the Canvas. This event tells you which "event_properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", @@ -9313,11 +10534,14 @@ This event occurs when a user enters into the Canvas. This event tells you which "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", @@ -9348,20 +10572,22 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -9374,17 +10600,19 @@ This event occurs when a user is enrolled in a control variant set on a multi-va { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -9398,9 +10626,11 @@ This event occurs when a user is enrolled in a control variant set on a multi-va { "app_id" : "(optional, string) API ID of the app on which this event occurred", "campaign_id" : "(required, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) Unix timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", @@ -9421,18 +10651,20 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received" + "campaign_name" : "(optional, string) Name of the campaign", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9460,12 +10692,14 @@ This event occurs when a user is enrolled in a control variant set on a multi-va { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received" + "campaign_name" : "(optional, string) Name of the campaign", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -9488,13 +10722,15 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", - "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received" + "campaign_name" : "(optional, string) Name of the campaign", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -9529,28 +10765,33 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "email_address" : "(optional, string) Email address of the user", - "phone_number" : "(optional, string) Phone number of the user in e.164 format (for example +14155552671)", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(required, string) Subscription group API ID", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", "channel" : "(optional, string) Channel this event belongs to", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", + "email_address" : "(optional, string) Email address of the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "phone_number" : "(optional, string) Phone number of the user in e.164 format (for example +14155552671)", "send_id" : "(optional, string) Message send ID this message belongs to", "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "subscription_group_id" : "(required, string) Subscription group API ID", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", - "external_user_id" : "(required, string) External ID of the user", "device_id" : "(optional, string) ID of the device on which the event occurred", - "timezone" : "(optional, string) Time zone of the user" + "external_user_id" : "(required, string) External ID of the user", + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -9563,23 +10804,28 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "email_address" : "(optional, string) Email address of the user", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "email_address" : "(optional, string) Email address of the user", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_group_id" : "(required, string) Subscription group API ID", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", "time" : "(required, int) Unix timestamp at which the event happened", - "send_id" : "(optional, string) Message send ID this message belongs to", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "token" : "(required, string) The Mixpanel API token" } } @@ -9593,14 +10839,19 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at { "app_id" : "(optional, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "channel" : "(optional, string) Channel this event belongs to", "email_address" : "(optional, string) Email address of the user", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "phone_number" : "(optional, string) Phone number of the user in e.164 format (for example +14155552671)", "send_id" : "(optional, string) Message send ID this message belongs to", "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", @@ -9625,24 +10876,29 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(required, string) Subscription group API ID", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc." + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_group_id" : "(required, string) Subscription group API ID", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9657,8 +10913,8 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(optional, string) Email address of the user" + "email" : "(optional, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -9671,19 +10927,24 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "email_address" : "(optional, string) Email address of the user", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "email_address" : "(optional, string) Email address of the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_group_id" : "(required, string) Subscription group API ID", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "timezone" : "(optional, string) Time zone of the user", - "send_id" : "(optional, string) Message send ID this message belongs to", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc." + "timezone" : "(optional, string) Time zone of the user" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -9708,18 +10969,23 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "subscription_group_id" : "(required, string) Subscription group API ID", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc." + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_group_id" : "(required, string) Subscription group API ID", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -9745,7 +11011,6 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at | Migration | When a user is updated by internal migrations or maintenance scripts | | User Merge | When a user is updated by the user merge process | | Canvas User Update Step | When a user is updated by the Canvas user update step | -| List-Unsubscribe | When a user unsubscribes via Braze mailto or one-click list-unsubscribe header | {: .reset-td-br-1 .reset-td-br-2} {% endapi %} @@ -9760,10 +11025,6 @@ Subscription This event occurs when Braze receives a request to update the global subscription state of the user, even if the request doesn't alter the current subscription state for the user. -{% alert important %} -When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated value called `List-Unsubscribe`. Previously, Braze sent the value `Other`. -{% endalert %} - {% tabs %} {% tab Braze Standard REST %} ```json @@ -9773,25 +11034,30 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "email_address" : "(optional, string) Email address of the user", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "channel" : "(optional, string) Channel this event belongs to", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "card_id" : "(optional, string) ID of the card this in app message comes from", + "channel" : "(optional, string) Channel this event belongs to", + "email_address" : "(optional, string) Email address of the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", "external_user_id" : "(required, string) External ID of the user", - "timezone" : "(optional, string) Time zone of the user" + "timezone" : "(optional, string) Time zone of the user", + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -9804,21 +11070,26 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "email_address" : "(optional, string) Email address of the user", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "time" : "(required, int) Unix timestamp at which the event happened", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "email_address" : "(optional, string) Email address of the user", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", + "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -9833,9 +11104,13 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", + "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "channel" : "(optional, string) Channel this event belongs to", "email_address" : "(optional, string) Email address of the user", "external_user_id" : "(optional, string) External ID of the user", @@ -9861,22 +11136,27 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened", "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", - "event_name" : "(required, string) The event type name, as it is exported to mParticle" + "event_name" : "(required, string) The event type name, as it is exported to mParticle", + "source_message_id" : "(required, string) Globally unique ID for this event", + "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9891,8 +11171,8 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated "schema_version" : 2, "user_attributes" : { }, "user_identities" : { - "customerid" : "(required, string) External ID of the user", - "email" : "(optional, string) Email address of the user" + "email" : "(optional, string) Email address of the user", + "customerid" : "(required, string) External ID of the user" } } ``` @@ -9904,18 +11184,23 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated { "event_properties" : { - "email_address" : "(optional, string) Email address of the user", - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "timezone" : "(optional, string) Time zone of the user", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "email_address" : "(optional, string) Email address of the user", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", + "timezone" : "(optional, string) Time zone of the user" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -9940,16 +11225,21 @@ When users unsubscribe with one-click list-unsubscribe, Braze sends a dedicated "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", - "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", - "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "campaign_name" : "(optional, string) Name of the campaign", "canvas_id" : "(optional, string) API ID of the Canvas this event belongs to", - "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_name" : "(optional, string) Name of the Canvas", "canvas_step_id" : "(optional, string) API ID of the Canvas step this event belongs to", - "send_id" : "(optional, string) Message send ID this message belongs to" + "canvas_step_name" : "(optional, string) Name of the Canvas step", + "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", + "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", + "message_variation_id" : "(optional, string) API ID of the message variation this user received", + "message_variation_name" : "(optional, string) Name of the message variation", + "send_id" : "(optional, string) Message send ID this message belongs to", + "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", + "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", @@ -10000,15 +11290,15 @@ This event is not fired when the user actually uninstalls the app, as that's imp "event_type" : "(required, string) The name of the event type", "id" : "(required, string) Globally unique ID for this event", "properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "card_id" : "(optional, string) ID of the card this in app message comes from" }, "time" : "(required, int) Unix timestamp at which the event happened", "user" : { - "user_id" : "(required, string) BSON ID of the user who performed this event", + "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred" + "user_id" : "(required, string) BSON ID of the user who performed this event" } } ``` @@ -10021,12 +11311,12 @@ This event is not fired when the user actually uninstalls the app, as that's imp { "event" : "(required, string) The event type name, as it is exported to Mixpanel", "properties" : { - "\\$partner_id" : "braze", - "$insert_id" : "(required, string) Globally unique ID for this event", - "distinct_id" : "(required, string) External ID of the user", - "device_id" : "(optional, string) ID of the device on which the event occurred", - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "$partner_id" : "braze", "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to", + "device_id" : "(optional, string) ID of the device on which the event occurred", + "distinct_id" : "(required, string) External ID of the user", + "$insert_id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) Unix timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } @@ -10061,12 +11351,12 @@ This event is not fired when the user actually uninstalls the app, as that's imp "event" : [ { "data" : { - "source_message_id" : "(required, string) Globally unique ID for this event", "custom_attributes" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred" + "device_id" : "(optional, string) ID of the device on which the event occurred" }, + "source_message_id" : "(required, string) Globally unique ID for this event", "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" @@ -10095,8 +11385,8 @@ This event is not fired when the user actually uninstalls the app, as that's imp { "device_id" : "(optional, string) ID of the device on which the event occurred", "event_properties" : { - "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred" + "app_id" : "(optional, string) API ID of the app on which this event occurred", + "app_group_id" : "(optional, string) API ID of the app group this user belongs to" }, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", @@ -10119,9 +11409,9 @@ This event is not fired when the user actually uninstalls the app, as that's imp "event" : "(required, string) The event type name, as it is exported to Segment", "messageId" : "(required, string) Globally unique ID for this event", "properties" : { - "device_id" : "(optional, string) ID of the device on which the event occurred", + "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "app_id" : "(optional, string) API ID of the app on which this event occurred" + "device_id" : "(optional, string) ID of the device on which the event occurred" }, "timestamp" : "(required, int) Unix timestamp at which the event happened", "type" : "track", From d692060c4447e9bfe41d52250d0c20010de682a8 Mon Sep 17 00:00:00 2001 From: isaiah robinson <95643215+internetisaiah@users.noreply.github.com> Date: Tue, 2 Jul 2024 10:42:28 -0700 Subject: [PATCH 2/5] Update customer_behavior_events.md --- .../customer_behavior_events.md | 72 +++++++++---------- 1 file changed, 36 insertions(+), 36 deletions(-) diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md index 59f4d6a2e6f..f884e826e0b 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md @@ -66,13 +66,13 @@ This event occurs when a specific custom event is triggered. Use this to track w "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "name" : "(required, string) Name of the custom event", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -102,7 +102,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "$insert_id" : "(required, string) Globally unique ID for this event", "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -126,7 +126,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "properties" : "(required, string) Custom properties stored as a JSON encoded string", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -154,7 +154,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -194,7 +194,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "ad_tracking_enabled" : "(optional, boolean) Whether advertising tracking is enabled for the device", "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "currency" : "(required, string) Currency of the purchase", "device_model" : "(optional, string) Model of the device", "os_version" : "(optional, string) Version of the operating system of the device", @@ -202,7 +202,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "price" : "(required, float) Price of the purchase", "product_id" : "(required, string) ID of the product purchased" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -234,7 +234,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "platform" : "(optional, string) Platform of the device", "price" : "(required, float) Price of the purchase", "product_id" : "(required, string) ID of the product purchased", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -260,7 +260,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "price" : "(required, float) Price of the purchase", "product_id" : "(required, string) ID of the product purchased", "properties" : "(required, string) Custom properties stored as a JSON encoded string", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -290,7 +290,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "library" : "Braze", "price" : "(required, float) Price of the purchase", "productId" : "(required, string) ID of the product purchased", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -328,13 +328,13 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(optional, string) UUID of the session" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -362,7 +362,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(optional, string) UUID of the session", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -386,7 +386,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "platform" : "(optional, string) Platform of the device", "sdk_version" : "(optional, string) Version of the Braze SDK in use during the event", "session_id" : "(required, string) UUID of the session", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -410,7 +410,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -444,13 +444,13 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(optional, string) UUID of the session" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -477,7 +477,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(optional, string) UUID of the session", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -497,7 +497,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(required, string) UUID of the session", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -520,7 +520,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -554,14 +554,14 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "duration" : "(optional, float) Duration of the session in seconds", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(optional, string) UUID of the session" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -589,7 +589,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(optional, string) UUID of the session", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -610,7 +610,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "session_id" : "(required, string) UUID of the session", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -634,7 +634,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -669,7 +669,7 @@ This event is triggered when a user visits a specified location. Use this to tra "altitude" : "(optional, float) Altitude of recorded location", "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "latitude" : "(required, float) Latitude of recorded location", "ll_accuracy" : "(optional, float) Accuracy of the latitude and longitude of recorded location", @@ -677,7 +677,7 @@ This event is triggered when a user visits a specified location. Use this to tra "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -711,7 +711,7 @@ This event is triggered when a user visits a specified location. Use this to tra "longitude" : "(required, float) Longitude of recorded location", "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -738,7 +738,7 @@ This event is triggered when a user visits a specified location. Use this to tra "longitude" : "(required, float) Longitude of recorded location", "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -770,7 +770,7 @@ This event is triggered when a user visits a specified location. Use this to tra "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -802,10 +802,10 @@ This event occurs when an app installation is attributed to a source. Use this t "id" : "(required, string) Globally unique ID for this event", "properties" : { "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "source" : "(optional, string) The source of the attribution" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -828,7 +828,7 @@ This event occurs when an app installation is attributed to a source. Use this t "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", "source" : "(optional, string) The source of the attribution", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -843,7 +843,7 @@ This event occurs when an app installation is attributed to a source. Use this t "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "source" : "(required, string) The source of the attribution", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -862,7 +862,7 @@ This event occurs when an app installation is attributed to a source. Use this t "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -892,7 +892,7 @@ This user event occurs every time a new user is created within their workspace. "id" : "(required, string) Globally unique ID for this event", "prev_random_bucket_number" : "(optional, int) Previous random bucket number", "random_bucket_number" : "(required, int) New random bucket number", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` From 8491d7fc4b839246584cee9271ee73e649d18e8c Mon Sep 17 00:00:00 2001 From: isaiah robinson <95643215+internetisaiah@users.noreply.github.com> Date: Tue, 2 Jul 2024 10:44:08 -0700 Subject: [PATCH 3/5] Update message_engagement_events.md --- .../message_engagement_events.md | 656 +++++++++--------- 1 file changed, 328 insertions(+), 328 deletions(-) diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md index 1280ad82273..fca24abeb64 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md @@ -88,7 +88,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -96,7 +96,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -132,7 +132,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -163,7 +163,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -203,7 +203,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -252,7 +252,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -288,7 +288,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, long) Unix timestamp at which the event happened", + "timestamp" : "(required, long) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -326,7 +326,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -336,7 +336,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -374,7 +374,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "provider_error_code" : "(required, string) Error code from WhatsApp", "provider_error_title" : "(required, string) Description of error from WhatsApp", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -407,7 +407,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "provider_error_code" : "(required, string) Error code from WhatsApp", "provider_error_title" : "(required, string) Description of error from WhatsApp", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -449,7 +449,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -500,7 +500,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -538,7 +538,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "provider_error_title" : "(required, string) Description of error from WhatsApp", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, long) Unix timestamp at which the event happened", + "timestamp" : "(required, long) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -576,7 +576,7 @@ This event occurs when a send request was successfully communicated between Braz "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(required, string) Phone number used to send in e.164 format (for example +14155552671)", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", @@ -585,7 +585,7 @@ This event occurs when a send request was successfully communicated between Braz "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -622,7 +622,7 @@ This event occurs when a send request was successfully communicated between Braz "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -653,7 +653,7 @@ This event occurs when a send request was successfully communicated between Braz "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -694,7 +694,7 @@ This event occurs when a send request was successfully communicated between Braz "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -744,7 +744,7 @@ This event occurs when a send request was successfully communicated between Braz "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -781,7 +781,7 @@ This event occurs when a send request was successfully communicated between Braz "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, long) Unix timestamp at which the event happened", + "timestamp" : "(required, long) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -821,14 +821,14 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -865,7 +865,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -897,7 +897,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -938,7 +938,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -988,7 +988,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -1025,7 +1025,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, long) Unix timestamp at which the event happened", + "timestamp" : "(required, long) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -1063,7 +1063,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", @@ -1073,7 +1073,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "subscription_group_id" : "(optional, string) Subscription group API ID", "user_phone_number" : "(required, string) The user's phone number from which the message was received" }, - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -1112,7 +1112,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token", "user_phone_number" : "(required, string) The user's phone number from which the message was received" } @@ -1146,7 +1146,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "message_variation_name" : "(optional, string) Name of the message variation", "quick_reply_text" : "(optional, string) Text of button pressed by the user", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(optional, string) BSON ID of the user who performed this event", "user_phone_number" : "(required, string) The user's phone number from which the message was received" @@ -1188,7 +1188,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, long) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, long) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1240,7 +1240,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, long) Unix timestamp at which the event happened", + "time" : "(required, long) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -1279,7 +1279,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "quick_reply_text" : "(optional, string) Text of button pressed by the user", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, long) Unix timestamp at which the event happened", + "timestamp" : "(required, long) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -1319,13 +1319,13 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -1362,7 +1362,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1393,7 +1393,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -1433,7 +1433,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1480,7 +1480,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -1515,7 +1515,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -1555,7 +1555,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", @@ -1563,7 +1563,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -1602,7 +1602,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1635,7 +1635,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -1676,7 +1676,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1726,7 +1726,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -1764,7 +1764,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -1805,14 +1805,14 @@ This event occurs if a push notification message was aborted based on Liquid abo "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -1851,7 +1851,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -1884,7 +1884,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -1926,7 +1926,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -1975,7 +1975,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -2014,7 +2014,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -2054,12 +2054,12 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -2092,7 +2092,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2121,7 +2121,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -2156,7 +2156,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2201,7 +2201,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -2234,7 +2234,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -2274,13 +2274,13 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -2317,7 +2317,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2348,7 +2348,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -2388,7 +2388,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2435,7 +2435,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -2470,7 +2470,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -2506,9 +2506,9 @@ This event occurs when a user has exited a Canvas by performing an event. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "card_id" : "(optional, string) ID of the card this in-app message comes from" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -2534,7 +2534,7 @@ This event occurs when a user has exited a Canvas by performing an event. "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2559,7 +2559,7 @@ This event occurs when a user has exited a Canvas by performing an event. "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -2587,7 +2587,7 @@ This event occurs when a user has exited a Canvas by performing an event. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2625,7 +2625,7 @@ This event occurs when a user has exited a Canvas by performing an event. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -2651,7 +2651,7 @@ This event occurs when a user has exited a Canvas by performing an event. "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -2687,9 +2687,9 @@ This event occurs when a user has exited a Canvas by matching an audience. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "card_id" : "(optional, string) ID of the card this in-app message comes from" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -2715,7 +2715,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2740,7 +2740,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -2768,7 +2768,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2806,7 +2806,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -2832,7 +2832,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -2866,13 +2866,13 @@ This event occurs when a user enters a Canvas experiment step path. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -2901,7 +2901,7 @@ This event occurs when a user enters a Canvas experiment step path. "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -2925,7 +2925,7 @@ This event occurs when a user enters a Canvas experiment step path. "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -2956,7 +2956,7 @@ This event occurs when a user enters a Canvas experiment step path. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -2997,7 +2997,7 @@ This event occurs when a user enters a Canvas experiment step path. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -3026,7 +3026,7 @@ This event occurs when a user enters a Canvas experiment step path. "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -3062,14 +3062,14 @@ This event occurs when a user convert for a Canvas experiment step. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "experiment_split_id" : "(optional, string) API ID of the experiment split the user enrolled in", "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -3100,7 +3100,7 @@ This event occurs when a user convert for a Canvas experiment step. "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3126,7 +3126,7 @@ This event occurs when a user convert for a Canvas experiment step. "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -3158,7 +3158,7 @@ This event occurs when a user convert for a Canvas experiment step. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3201,7 +3201,7 @@ This event occurs when a user convert for a Canvas experiment step. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -3232,7 +3232,7 @@ This event occurs when a user convert for a Canvas experiment step. "experiment_split_name" : "(optional, string) Name of the experiment split", "experiment_step_id" : "(optional, string) API ID of the experiment step this event belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -3274,7 +3274,7 @@ This event occurs when Braze processes a push message for a user, communicating "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -3282,7 +3282,7 @@ This event occurs when Braze processes a push message for a user, communicating "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -3323,7 +3323,7 @@ This event occurs when Braze processes a push message for a user, communicating "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3356,7 +3356,7 @@ This event occurs when Braze processes a push message for a user, communicating "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -3402,7 +3402,7 @@ This event occurs when Braze processes a push message for a user, communicating "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3455,7 +3455,7 @@ This event occurs when Braze processes a push message for a user, communicating "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -3496,7 +3496,7 @@ This event occurs when Braze processes a push message for a user, communicating "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -3543,7 +3543,7 @@ This event occurs when a user directly clicks on the Push notification to open t "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -3552,7 +3552,7 @@ This event occurs when a user directly clicks on the Push notification to open t "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -3594,7 +3594,7 @@ This event occurs when a user directly clicks on the Push notification to open t "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3631,7 +3631,7 @@ This event occurs when a user directly clicks on the Push notification to open t "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -3677,7 +3677,7 @@ This event occurs when a user directly clicks on the Push notification to open t "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -3731,7 +3731,7 @@ This event occurs when a user directly clicks on the Push notification to open t "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -3772,7 +3772,7 @@ This event occurs when a user directly clicks on the Push notification to open t "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -3816,7 +3816,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -3825,7 +3825,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -3867,7 +3867,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -3899,7 +3899,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(required, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -3939,7 +3939,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -3980,7 +3980,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -4024,14 +4024,14 @@ This event occurs when an error is received from either Apple Push Notification "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -4071,7 +4071,7 @@ This event occurs when an error is received from either Apple Push Notification "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -4103,7 +4103,7 @@ This event occurs when an error is received from either Apple Push Notification "message_variation_name" : "(optional, string) Name of the message variation", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -4148,7 +4148,7 @@ This event occurs when an error is received from either Apple Push Notification "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4200,7 +4200,7 @@ This event occurs when an error is received from either Apple Push Notification "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -4240,7 +4240,7 @@ This event occurs when an error is received from either Apple Push Notification "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -4279,7 +4279,7 @@ This event occurs when an email send request was successfully communicated betwe "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", @@ -4288,7 +4288,7 @@ This event occurs when an email send request was successfully communicated betwe "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -4326,7 +4326,7 @@ This event occurs when an email send request was successfully communicated betwe "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -4355,7 +4355,7 @@ This event occurs when an email send request was successfully communicated betwe "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -4397,7 +4397,7 @@ This event occurs when an email send request was successfully communicated betwe "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4446,7 +4446,7 @@ This event occurs when an email send request was successfully communicated betwe "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -4485,7 +4485,7 @@ This event occurs when an email send request was successfully communicated betwe "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -4528,7 +4528,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -4539,7 +4539,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -4578,7 +4578,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -4609,7 +4609,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -4650,7 +4650,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4700,7 +4700,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -4738,7 +4738,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -4780,7 +4780,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", "device_model" : "(optional, string) Model of the device", "device_os" : "(optional, string) Device operating system extracted from user_agent", @@ -4797,7 +4797,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "send_id" : "(optional, string) Message send ID this message belongs to", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -4843,7 +4843,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token", "user_agent" : "(optional, string) User agent on which the spam report occurred" } @@ -4881,7 +4881,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_agent" : "(optional, string) User agent on which the spam report occurred", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -4931,7 +4931,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -4989,7 +4989,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -5036,7 +5036,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "send_id" : "(optional, string) Message send ID this message belongs to", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -5078,7 +5078,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_class" : "(optional, string) Device class extracted from user_agent (mobile, desktop, tablet, etc...)", "device_model" : "(optional, string) Model of the device", "device_os" : "(optional, string) Device operating system extracted from user_agent", @@ -5097,7 +5097,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -5144,7 +5144,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token", "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred" @@ -5184,7 +5184,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", @@ -5237,7 +5237,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5297,7 +5297,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -5347,7 +5347,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "link_url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -5389,7 +5389,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -5401,7 +5401,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -5442,7 +5442,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -5475,7 +5475,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -5518,7 +5518,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5570,7 +5570,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -5610,7 +5610,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -5652,7 +5652,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -5663,7 +5663,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -5703,7 +5703,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -5735,7 +5735,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "sending_ip" : "(optional, string) IP address from which the email send was made", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -5777,7 +5777,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -5828,7 +5828,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -5867,7 +5867,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -5908,7 +5908,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "esp" : "(optional, string) ESP related to the event (Sparkpost or Sendgrid)", @@ -5919,7 +5919,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "send_id" : "(optional, string) Message send ID this message belongs to", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -5958,7 +5958,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token", "user_agent" : "(optional, string) User agent on which the spam report occurred" } @@ -5989,7 +5989,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_agent" : "(optional, string) User agent on which the spam report occurred", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -6032,7 +6032,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6083,7 +6083,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -6122,7 +6122,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "send_id" : "(optional, string) Message send ID this message belongs to", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -6168,7 +6168,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "email_address" : "(required, string) Email address of the user", "ip_pool" : "(optional, string) IP pool from which the email send was made", @@ -6176,7 +6176,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -6213,7 +6213,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6241,7 +6241,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -6280,7 +6280,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6328,7 +6328,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -6364,7 +6364,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -6409,7 +6409,7 @@ This event occurs when a user views an in-app message. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", @@ -6419,7 +6419,7 @@ This event occurs when a user views an in-app message. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -6463,7 +6463,7 @@ This event occurs when a user views an in-app message. "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6498,7 +6498,7 @@ This event occurs when a user views an in-app message. "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -6546,7 +6546,7 @@ This event occurs when a user views an in-app message. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6602,7 +6602,7 @@ This event occurs when a user views an in-app message. "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -6645,7 +6645,7 @@ This event occurs when a user views an in-app message. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -6695,7 +6695,7 @@ This event occurs when a user clicks on an in-app message. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -6704,7 +6704,7 @@ This event occurs when a user clicks on an in-app message. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -6748,7 +6748,7 @@ This event occurs when a user clicks on an in-app message. "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -6783,7 +6783,7 @@ This event occurs when a user clicks on an in-app message. "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -6831,7 +6831,7 @@ This event occurs when a user clicks on an in-app message. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -6887,7 +6887,7 @@ This event occurs when a user clicks on an in-app message. "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -6930,7 +6930,7 @@ This event occurs when a user clicks on an in-app message. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -6972,14 +6972,14 @@ This event occurs when a webhook was processed and sent to the third party speci "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -7015,7 +7015,7 @@ This event occurs when a webhook was processed and sent to the third party speci "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -7041,7 +7041,7 @@ This event occurs when a webhook was processed and sent to the third party speci "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -7080,7 +7080,7 @@ This event occurs when a webhook was processed and sent to the third party speci "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7126,7 +7126,7 @@ This event occurs when a webhook was processed and sent to the third party speci "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -7160,7 +7160,7 @@ This event occurs when a webhook was processed and sent to the third party speci "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -7201,7 +7201,7 @@ This event occurs when a Content Card gets sent to a user. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "content_card_id" : "(required, string) ID of the card that generated this event", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", @@ -7209,7 +7209,7 @@ This event occurs when a Content Card gets sent to a user. "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -7246,7 +7246,7 @@ This event occurs when a Content Card gets sent to a user. "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -7274,7 +7274,7 @@ This event occurs when a Content Card gets sent to a user. "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -7314,7 +7314,7 @@ This event occurs when a Content Card gets sent to a user. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7361,7 +7361,7 @@ This event occurs when a Content Card gets sent to a user. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -7396,7 +7396,7 @@ This event occurs when a Content Card gets sent to a user. "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -7440,7 +7440,7 @@ This event occurs when a user views a Content Card. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "content_card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", @@ -7450,7 +7450,7 @@ This event occurs when a user views a Content Card. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -7493,7 +7493,7 @@ This event occurs when a user views a Content Card. "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -7527,7 +7527,7 @@ This event occurs when a user views a Content Card. "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -7574,7 +7574,7 @@ This event occurs when a user views a Content Card. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7629,7 +7629,7 @@ This event occurs when a user views a Content Card. "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -7671,7 +7671,7 @@ This event occurs when a user views a Content Card. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -7715,7 +7715,7 @@ This event occurs when a user clicks a Content Card. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "content_card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", @@ -7725,7 +7725,7 @@ This event occurs when a user clicks a Content Card. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -7768,7 +7768,7 @@ This event occurs when a user clicks a Content Card. "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -7802,7 +7802,7 @@ This event occurs when a user clicks a Content Card. "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -7849,7 +7849,7 @@ This event occurs when a user clicks a Content Card. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -7904,7 +7904,7 @@ This event occurs when a user clicks a Content Card. "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -7946,7 +7946,7 @@ This event occurs when a user clicks a Content Card. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -7991,7 +7991,7 @@ This event occurs when a user dismisses a Content Card. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "content_card_id" : "(required, string) ID of the card that generated this event", "device_model" : "(optional, string) Model of the device", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", @@ -8001,7 +8001,7 @@ This event occurs when a user dismisses a Content Card. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -8044,7 +8044,7 @@ This event occurs when a user dismisses a Content Card. "$os" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -8078,7 +8078,7 @@ This event occurs when a user dismisses a Content Card. "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -8125,7 +8125,7 @@ This event occurs when a user dismisses a Content Card. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8180,7 +8180,7 @@ This event occurs when a user dismisses a Content Card. "idfa" : "(optional, string) Advertising identifier", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -8222,7 +8222,7 @@ This event occurs when a user dismisses a Content Card. "platform" : "(optional, string) Platform of the device", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -8264,7 +8264,7 @@ This event occurs when a user clicks an SMS short link. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", @@ -8272,7 +8272,7 @@ This event occurs when a user clicks an SMS short link. "user_agent" : "(optional, string) User agent on which the spam report occurred", "user_phone_number" : "(optional, string) The user's phone number from which the message was received" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -8306,7 +8306,7 @@ This event occurs when a user clicks an SMS short link. "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token", "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", @@ -8335,7 +8335,7 @@ This event occurs when a user clicks an SMS short link. "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "short_url" : "(required, string) Shortened url that was clicked", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "url" : "(required, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", @@ -8377,7 +8377,7 @@ This event occurs when a user clicks an SMS short link. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8426,7 +8426,7 @@ This event occurs when a user clicks an SMS short link. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -8463,7 +8463,7 @@ This event occurs when a user clicks an SMS short link. "link_url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -8499,7 +8499,7 @@ This event occurs when a user sends an SMS. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "category" : "(optional, string) Keyword category name, only populated for auto-reply messages: 'opt-in', 'opt-out', 'help', or custom value", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_extras" : "(optional, string) A JSON string of the tagged key-value pairs during liquid rendering", @@ -8509,7 +8509,7 @@ This event occurs when a user sends an SMS. "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -8547,7 +8547,7 @@ This event occurs when a user sends an SMS. "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -8577,7 +8577,7 @@ This event occurs when a user sends an SMS. "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -8619,7 +8619,7 @@ This event occurs when a user sends an SMS. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8670,7 +8670,7 @@ This event occurs when a user sends an SMS. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -8708,7 +8708,7 @@ This event occurs when a user sends an SMS. "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -8753,7 +8753,7 @@ This event occurs when an SMS is sent to the carrier. "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -8762,7 +8762,7 @@ This event occurs when an SMS is sent to the carrier. "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -8799,7 +8799,7 @@ This event occurs when an SMS is sent to the carrier. "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -8828,7 +8828,7 @@ This event occurs when an SMS is sent to the carrier. "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -8869,7 +8869,7 @@ This event occurs when an SMS is sent to the carrier. "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -8919,7 +8919,7 @@ This event occurs when an SMS is sent to the carrier. "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -8956,7 +8956,7 @@ This event occurs when an SMS is sent to the carrier. "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -8994,7 +8994,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -9003,7 +9003,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -9040,7 +9040,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -9069,7 +9069,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -9110,7 +9110,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9160,7 +9160,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -9197,7 +9197,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -9235,7 +9235,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", "from_phone_number" : "(optional, string) Phone number used to send in e.164 format (for example +14155552671)", @@ -9246,7 +9246,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -9285,7 +9285,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "provider_error_code" : "(optional, string) Error code from WhatsApp", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -9316,7 +9316,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "provider_error_code" : "(optional, string) Error code from WhatsApp", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -9359,7 +9359,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9411,7 +9411,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -9450,7 +9450,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -9489,7 +9489,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "error" : "(optional, string) Error name", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -9499,7 +9499,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "subscription_group_id" : "(optional, string) Subscription group API ID", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -9537,7 +9537,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "provider_error_code" : "(optional, string) Error code from WhatsApp", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "token" : "(required, string) The Mixpanel API token" } @@ -9567,7 +9567,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "provider_error_code" : "(optional, string) Error code from WhatsApp", "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -9609,7 +9609,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9660,7 +9660,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -9698,7 +9698,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "send_id" : "(optional, string) Message send ID this message belongs to", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -9740,7 +9740,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "inbound_phone_number" : "(required, string) The inbound number that the message was sent to", "media_urls" : "(optional, array of string) Media URLs from the user", "message_body" : "(optional, string) Typed response from the user", @@ -9749,7 +9749,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "subscription_group_id" : "(optional, string) Subscription group API ID", "user_phone_number" : "(required, string) The user's phone number from which the message was received" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" @@ -9784,7 +9784,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token", "user_phone_number" : "(required, string) The user's phone number from which the message was received" } @@ -9815,7 +9815,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) BSON ID of subscription group", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) BSON ID of the user who performed this event", "user_phone_number" : "(required, string) The user's phone number from which the message was received" } @@ -9852,7 +9852,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -9902,7 +9902,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -9939,7 +9939,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -9977,7 +9977,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", "campaign_name" : "(optional, string) Name of the campaign", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", @@ -9985,7 +9985,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -10017,7 +10017,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -10039,7 +10039,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -10073,7 +10073,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -10115,7 +10115,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -10145,7 +10145,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -10187,11 +10187,11 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "conversion_behavior" : "(optional, string) JSON-encoded string describing the conversion behavior", "conversion_behavior_index" : "(optional, int) Index of the conversion behavior" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -10223,7 +10223,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "device_id" : "(optional, string) ID of the device on which the event occurred", "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -10246,7 +10246,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -10280,7 +10280,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -10322,7 +10322,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -10352,7 +10352,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "conversion_behavior_index" : "(optional, int) Index of the conversion behavior", "device_id" : "(optional, string) ID of the device on which the event occurred" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -10389,10 +10389,10 @@ This event occurs when a user enters into the Canvas. This event tells you which "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -10422,7 +10422,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -10443,7 +10443,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -10476,7 +10476,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -10516,7 +10516,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -10544,7 +10544,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "device_id" : "(optional, string) ID of the device on which the event occurred", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -10576,13 +10576,13 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "campaign_id" : "(optional, string) API ID of the campaign this event belongs to", "campaign_name" : "(optional, string) Name of the campaign", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "dispatch_id" : "(optional, string) ID of the dispatch this message belongs to", "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -10612,7 +10612,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -10632,7 +10632,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "message_variation_id" : "(optional, string) API ID of the message variation this user received", "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -10664,7 +10664,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -10704,7 +10704,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -10732,7 +10732,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "message_variation_name" : "(optional, string) Name of the message variation", "send_id" : "(optional, string) Message send ID this message belongs to" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -10775,7 +10775,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "channel" : "(optional, string) Channel this event belongs to", "email_address" : "(optional, string) Email address of the user", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -10786,7 +10786,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "subscription_group_id" : "(required, string) Subscription group API ID", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -10825,7 +10825,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_group_id" : "(required, string) Subscription group API ID", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -10857,7 +10857,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_group_id" : "(required, string) Subscription group API ID", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -10898,7 +10898,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -10949,7 +10949,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -10987,7 +10987,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "subscription_group_id" : "(required, string) Subscription group API ID", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -11044,7 +11044,7 @@ This event occurs when Braze receives a request to update the global subscriptio "canvas_step_name" : "(optional, string) Name of the Canvas step", "canvas_variation_id" : "(optional, string) API ID of the Canvas variation this event belongs to", "canvas_variation_name" : "(optional, string) Name of the Canvas variation this user received", - "card_id" : "(optional, string) ID of the card this in app message comes from", + "card_id" : "(optional, string) ID of the card this in-app message comes from", "channel" : "(optional, string) Channel this event belongs to", "email_address" : "(optional, string) Email address of the user", "message_variation_id" : "(optional, string) API ID of the message variation this user received", @@ -11053,7 +11053,7 @@ This event occurs when Braze receives a request to update the global subscriptio "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", @@ -11089,7 +11089,7 @@ This event occurs when Braze receives a request to update the global subscriptio "send_id" : "(optional, string) Message send ID this message belongs to", "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -11119,7 +11119,7 @@ This event occurs when Braze receives a request to update the global subscriptio "send_id" : "(optional, string) Message send ID this message belongs to", "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_id" : "(required, string) BSON ID of the user who performed this event" } @@ -11156,7 +11156,7 @@ This event occurs when Braze receives a request to update the global subscriptio "custom_event_type" : "(required, string) The mParticle custom event type if the event_type is 'custom_event' (always 'other')", "event_name" : "(required, string) The event type name, as it is exported to mParticle", "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -11205,7 +11205,7 @@ This event occurs when Braze receives a request to update the global subscriptio "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -11241,7 +11241,7 @@ This event occurs when Braze receives a request to update the global subscriptio "state_change_source" : "(optional, string) Source of the state change, e.g: REST API, SDK, Dashboard, etc.", "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } @@ -11292,9 +11292,9 @@ This event is not fired when the user actually uninstalls the app, as that's imp "properties" : { "app_id" : "(optional, string) API ID of the app on which this event occurred", "app_group_id" : "(optional, string) API ID of the app group this user belongs to", - "card_id" : "(optional, string) ID of the card this in app message comes from" + "card_id" : "(optional, string) ID of the card this in-app message comes from" }, - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", @@ -11317,7 +11317,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "device_id" : "(optional, string) ID of the device on which the event occurred", "distinct_id" : "(required, string) External ID of the user", "$insert_id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "token" : "(required, string) The Mixpanel API token" } } @@ -11333,7 +11333,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(required, string) BSON ID of the user who performed this event" } ``` @@ -11357,7 +11357,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "device_id" : "(optional, string) ID of the device on which the event occurred" }, "source_message_id" : "(required, string) Globally unique ID for this event", - "timestamp_unixtime_ms" : "(required, int) Unix timestamp at which the event happened" + "timestamp_unixtime_ms" : "(required, int) UNIX timestamp at which the event happened" }, "event_type" : "(required, string) mParticle event type (either 'uninstall' or 'custom_event')" } @@ -11391,7 +11391,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "event_type" : "(required, string) The event type name, as it is exported to Amplitude", "insert_id" : "(required, string) Globally unique ID for this event", "library" : "Braze", - "time" : "(required, int) Unix timestamp at which the event happened", + "time" : "(required, int) UNIX timestamp at which the event happened", "user_id" : "(optional, string) External ID of the user" } ``` @@ -11413,7 +11413,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "app_group_id" : "(optional, string) API ID of the app group this user belongs to", "device_id" : "(optional, string) ID of the device on which the event occurred" }, - "timestamp" : "(required, int) Unix timestamp at which the event happened", + "timestamp" : "(required, int) UNIX timestamp at which the event happened", "type" : "track", "userId" : "(required, string) External ID of the user" } From 6724cd2ea74f331db7bdd282acc6e5208693b78a Mon Sep 17 00:00:00 2001 From: isaiah robinson <95643215+internetisaiah@users.noreply.github.com> Date: Tue, 2 Jul 2024 11:21:02 -0700 Subject: [PATCH 4/5] Change BSON to Braze ID --- .../customer_behavior_events.md | 30 +++++++++---------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md index f884e826e0b..cc72dcb356a 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/customer_behavior_events.md @@ -77,7 +77,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -128,7 +128,7 @@ This event occurs when a specific custom event is triggered. Use this to track w "properties" : "(required, string) Custom properties stored as a JSON encoded string", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -206,7 +206,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -261,7 +261,7 @@ Purchases are special custom events and come with a JSON encoded string of custo "product_id" : "(required, string) ID of the product purchased", "properties" : "(required, string) Custom properties stored as a JSON encoded string", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -339,7 +339,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -388,7 +388,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "session_id" : "(required, string) UUID of the session", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -454,7 +454,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -498,7 +498,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "platform" : "(optional, string) Platform of the device", "session_id" : "(required, string) UUID of the session", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -565,7 +565,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -611,7 +611,7 @@ When a user starts their first session, both a `FirstSession` and a `SessionStar "platform" : "(optional, string) Platform of the device", "session_id" : "(required, string) UUID of the session", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -681,7 +681,7 @@ This event is triggered when a user visits a specified location. Use this to tra "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -739,7 +739,7 @@ This event is triggered when a user visits a specified location. Use this to tra "os_version" : "(optional, string) Version of the operating system of the device", "platform" : "(optional, string) Platform of the device", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -809,7 +809,7 @@ This event occurs when an app installation is attributed to a source. Use this t "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -844,7 +844,7 @@ This event occurs when an app installation is attributed to a source. Use this t "id" : "(required, string) Globally unique ID for this event", "source" : "(required, string) The source of the attribution", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -893,7 +893,7 @@ This user event occurs every time a new user is created within their workspace. "prev_random_bucket_number" : "(optional, int) Previous random bucket number", "random_bucket_number" : "(required, int) New random bucket number", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} From 94990425f1d1d48776564fb36600a7ffc4de8f77 Mon Sep 17 00:00:00 2001 From: isaiah robinson <95643215+internetisaiah@users.noreply.github.com> Date: Tue, 2 Jul 2024 11:22:49 -0700 Subject: [PATCH 5/5] Change B --- .../message_engagement_events.md | 184 +++++++++--------- 1 file changed, 92 insertions(+), 92 deletions(-) diff --git a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md index fca24abeb64..5fa83a1787b 100644 --- a/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md +++ b/_docs/_user_guide/data_and_analytics/braze_currents/event_glossary/message_engagement_events.md @@ -101,7 +101,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -166,7 +166,7 @@ This event occurs when an WhatsApp message sent made it successfully to the end- "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -341,7 +341,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -410,7 +410,7 @@ This event occurs when WhatsApp cannot deliver the message to the user. A hard b "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -590,7 +590,7 @@ This event occurs when a send request was successfully communicated between Braz "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -656,7 +656,7 @@ This event occurs when a send request was successfully communicated between Braz "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -833,7 +833,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -900,7 +900,7 @@ This event occurs if a WhatsApp message was aborted based on Liquid aborts, Quie "time" : "(required, long) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -1078,7 +1078,7 @@ This event occurs when one of your users sends a WhatsApp message to a phone num "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -1330,7 +1330,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -1395,7 +1395,7 @@ This event occurs if a Content Card message was aborted based on Liquid aborts, "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -1568,7 +1568,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -1637,7 +1637,7 @@ This event occurs if an email message was aborted based on Liquid aborts, Quiet "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -1817,7 +1817,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -1886,7 +1886,7 @@ This event occurs if a push notification message was aborted based on Liquid abo "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2062,7 +2062,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -2122,7 +2122,7 @@ This event occurs if an SMS message was aborted based on Liquid aborts, Quiet Ho "message_variation_name" : "(optional, string) Name of the message variation", "subscription_group_id" : "(optional, string) Subscription group API ID", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2285,7 +2285,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -2350,7 +2350,7 @@ This event occurs if a webhook message was aborted based on Liquid aborts or Qui "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2511,7 +2511,7 @@ This event occurs when a user has exited a Canvas by performing an event. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -2560,7 +2560,7 @@ This event occurs when a user has exited a Canvas by performing an event. "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2692,7 +2692,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -2741,7 +2741,7 @@ This event occurs when a user has exited a Canvas by matching an audience. "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -2875,7 +2875,7 @@ This event occurs when a user enters a Canvas experiment step path. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -2926,7 +2926,7 @@ This event occurs when a user enters a Canvas experiment step path. "id" : "(required, string) Globally unique ID for this event", "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3072,7 +3072,7 @@ This event occurs when a user convert for a Canvas experiment step. "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -3127,7 +3127,7 @@ This event occurs when a user convert for a Canvas experiment step. "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3287,7 +3287,7 @@ This event occurs when Braze processes a push message for a user, communicating "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -3358,7 +3358,7 @@ This event occurs when Braze processes a push message for a user, communicating "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3557,7 +3557,7 @@ This event occurs when a user directly clicks on the Push notification to open t "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -3633,7 +3633,7 @@ This event occurs when a user directly clicks on the Push notification to open t "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -3830,7 +3830,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -3901,7 +3901,7 @@ This event is not supported by our [Swift SDK](https://github.com/braze-inc/braz "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4036,7 +4036,7 @@ This event occurs when an error is received from either Apple Push Notification "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -4105,7 +4105,7 @@ This event occurs when an error is received from either Apple Push Notification "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4293,7 +4293,7 @@ This event occurs when an email send request was successfully communicated betwe "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -4357,7 +4357,7 @@ This event occurs when an email send request was successfully communicated betwe "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4544,7 +4544,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -4611,7 +4611,7 @@ This event occurs when an email sent made it successfully to the end-users inbox "sending_ip" : "(optional, string) IP address from which the email send was made", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -4802,7 +4802,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -4884,7 +4884,7 @@ This event occurs when a user opens an email. Multiple events may be generated f "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_agent" : "(optional, string) User agent on which the spam report occurred", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5102,7 +5102,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -5188,7 +5188,7 @@ This event occurs when a user clicks an email. Multiple events may be generated "timezone" : "(optional, string) Time zone of the user", "url" : "(optional, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5406,7 +5406,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -5477,7 +5477,7 @@ This event occurs when an Internet Service Provider returns a hard bounce. A har "sending_ip" : "(optional, string) IP address from which the email send was made", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5668,7 +5668,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -5737,7 +5737,7 @@ This event occurs when an Internet Service Provider returns a soft bounce. A sof "sending_ip" : "(optional, string) IP address from which the email send was made", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -5924,7 +5924,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -5992,7 +5992,7 @@ This event occurs when the end-user hits the "spam" button on the email. Note th "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "user_agent" : "(optional, string) User agent on which the spam report occurred", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6181,7 +6181,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -6243,7 +6243,7 @@ The `Unsubscribe` event is actually a specialized click event that is fired when "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6424,7 +6424,7 @@ This event occurs when a user views an in-app message. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -6500,7 +6500,7 @@ This event occurs when a user views an in-app message. "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6709,7 +6709,7 @@ This event occurs when a user clicks on an in-app message. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -6785,7 +6785,7 @@ This event occurs when a user clicks on an in-app message. "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -6984,7 +6984,7 @@ This event occurs when a webhook was processed and sent to the third party speci "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -7043,7 +7043,7 @@ This event occurs when a webhook was processed and sent to the third party speci "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -7214,7 +7214,7 @@ This event occurs when a Content Card gets sent to a user. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -7276,7 +7276,7 @@ This event occurs when a Content Card gets sent to a user. "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -7455,7 +7455,7 @@ This event occurs when a user views a Content Card. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -7529,7 +7529,7 @@ This event occurs when a user views a Content Card. "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -7730,7 +7730,7 @@ This event occurs when a user clicks a Content Card. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -7804,7 +7804,7 @@ This event occurs when a user clicks a Content Card. "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -8006,7 +8006,7 @@ This event occurs when a user dismisses a Content Card. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -8080,7 +8080,7 @@ This event occurs when a user dismisses a Content Card. "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -8277,7 +8277,7 @@ This event occurs when a user clicks an SMS short link. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -8339,7 +8339,7 @@ This event occurs when a user clicks an SMS short link. "timezone" : "(optional, string) Time zone of the user", "url" : "(required, string) URL that the user clicked on", "user_agent" : "(optional, string) User agent on which the spam report occurred", - "user_id" : "(required, string) BSON ID of the user who performed this event", + "user_id": (required, string) Braze user ID of the user who performed this event", "user_phone_number" : "(optional, string) The user's phone number from which the message was received" } ``` @@ -8514,7 +8514,7 @@ This event occurs when a user sends an SMS. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -8580,7 +8580,7 @@ This event occurs when a user sends an SMS. "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -8767,7 +8767,7 @@ This event occurs when an SMS is sent to the carrier. "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -8831,7 +8831,7 @@ This event occurs when an SMS is sent to the carrier. "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9008,7 +9008,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -9072,7 +9072,7 @@ This event occurs when an SMS was successfully delivered to the users mobile pho "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9251,7 +9251,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -9319,7 +9319,7 @@ This event occurs when an SMS send gets rejected by the carrier, this can happen "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9504,7 +9504,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -9570,7 +9570,7 @@ This event occurs when an SMS experiences delivery failure. Use this event and t "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", "to_phone_number" : "(optional, string) Phone number of the user receiving the message in e.164 format (for example +14155552671)", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -9752,7 +9752,7 @@ If we detect that this inbound message is a reply to an outbound campaign or Can "time" : "(required, int) UNIX timestamp at which the event happened", "user" : { "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -9990,7 +9990,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -10041,7 +10041,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10196,7 +10196,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -10248,7 +10248,7 @@ Note that the conversion event is encoded in the `conversion_behavior` field, wh "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10397,7 +10397,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -10445,7 +10445,7 @@ This event occurs when a user enters into the Canvas. This event tells you which "in_control_group" : "(required, boolean) Whether the user was enrolled in the control group", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10587,7 +10587,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -10634,7 +10634,7 @@ This event occurs when a user is enrolled in a control variant set on a multi-va "send_id" : "(optional, string) Message send ID this message belongs to", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -10791,7 +10791,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -10859,7 +10859,7 @@ Subscription groups are only available for email, SMS, and WhatsApp channels at "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -11057,7 +11057,7 @@ This event occurs when Braze receives a request to update the global subscriptio "user" : { "external_user_id" : "(required, string) External ID of the user", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -11121,7 +11121,7 @@ This event occurs when Braze receives a request to update the global subscriptio "subscription_status" : "(required, string) Subscription status: 'Subscribed' or 'Unsubscribed'", "time" : "(required, int) UNIX timestamp at which the event happened", "timezone" : "(optional, string) Time zone of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %} @@ -11298,7 +11298,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "user" : { "device_id" : "(optional, string) ID of the device on which the event occurred", "external_user_id" : "(required, string) External ID of the user", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } } ``` @@ -11334,7 +11334,7 @@ This event is not fired when the user actually uninstalls the app, as that's imp "external_user_id" : "(optional, string) External ID of the user", "id" : "(required, string) Globally unique ID for this event", "time" : "(required, int) UNIX timestamp at which the event happened", - "user_id" : "(required, string) BSON ID of the user who performed this event" + "user_id": (required, string) Braze user ID of the user who performed this event" } ``` {% endtab %}