mParticle Event Import
Sending events from mParticle to Branch will allow you to attribute downstream conversions like purchases across web and app to Branch link clicks. Events imported from mParticle to Branch will be available wherever you can normally use events within Branch, including dashboard visualizations, Data Feeds, Universal Ads postbacks, Journeys targeting, Liveview and more.
This guide walks through the server-side integration for data import from mParticle to Branch. For the client-side integration, see the mParticle iOS or android documentation. For data export from Branch to mParticle, go here.
What events does Branch import?¶
Branch will import events that are not auto-tracked with the Branch SDKs. This includes commerce, content, user lifecycle, and custom events, and excludes events like clicks and installs. See the full list of supported events and associated mappings here. Branch will only import events that can be tied to a user.
- Contact Branch to configure Branch to receive events from mParticle. Please note that a subscription to Data Feeds is required to enable data import from mParticle to Branch.
Navigate to the Data Integrations page of the Branch dashboard.
- Select mParticle from the menu on the left.
- Select the platforms you would like to import events from and click Save.
Navigate to your your mParticle UI’s Connections page.
Avoid duplicate data
To avoid duplicate data, you should either track conversion events directly with Branch or track events with mParticle and then enable import to Branch, not both. Branch will warn you if you try to import events to Branch that you are already tracking.
The Branch integration supports some of the events tracked with mParticle’s API or SDKs. Branch will only import events from mParticle that are not already auto-tracked with the Branch SDK. This means that events like click and install cannot be imported. The following outlines how mParticle events are mapped to Branch events, and which will be imported to Branch:
|mParticle Action||mParticle Event Type||mParticle Custom Event Type||Branch Event||Branch Event Category||Imported|
|add_to_cart||product_action||-||Add To Cart||Commerce Event||Yes|
|add_to_wishlist||product_action||-||Add To Wishlist||Commerce Event||Yes|
|use the Branch event name||-||-||View Cart||Commerce Event||Yes|
|use the Branch event name||-||-||Add Payment Info||Commerce Event||Yes|
|checkout||product_action||-||Initiate Purchase||Commerce Event||Yes|
|use the Branch event name||-||-||Spend Credits||Commerce Event||Yes|
|use the Branch event name||custom_event||search||Search||Content Event||Yes|
|view_detail||product_action||-||View Item||Content Event||Yes|
|view_detail||product_action||-||View Items||Content Event||Yes|
|use the Branch event name||-||-||Rate||Content Event||Yes|
|use the Branch event name||-||-||Share||Content Event||Yes|
|use the Branch event name||-||-||Complete Registration||Lifecycle Event||Yes|
|use the Branch event name||-||-||Complete Tutorial||Lifecycle Event||Yes|
|use the Branch event name||-||-||Achieve Level||Lifecycle Event||Yes|
|use the Branch event name||-||-||Unlock Achievement||Lifecycle Event||Yes|
|use the Branch event name||-||-||Custom||Custom Event||Yes|
|-||-||-||Web Session Start||-||No|
|-||-||-||Branch CTA View||-||No|
|-||-||-||Web to App Auto Redirect||-||No|
Identifiers are required for events to be imported to Branch. You must include:
- context.userId.Customer OR
- (environment.Identity.DeviceIdentity.IOS_ADVERTISING_ID OR environment.Identity.DeviceIdentity.IOS_VENDOR_ID) AND context.runtimeEnvironment.type OR
- (environment.Identity.DeviceIdentity.GOOGLE_ADVERTISING_ID OR environment.Identity.DeviceIdentity.ANDROID_ID) AND context.runtimeEnvironment.type
Branch maps mParticle's identifiers to the following:
|mParticle field||Branch field|
At this time, Branch will not attribute logged out web events received from the server-to-server integration.
Validating the integration¶
Once you have import turned on in both mParticle and Branch, events should come through. You will see a green dot on the import card if Branch has seen events:
To see more information on the events that are coming in, you can look at events with origin
MPARTICLE in Liveview:
Branch imports events from mParticle as commerce, user lifecycle, content, or custom events.
Using imported events¶
Events imported from mParticle to Branch will be available wherever you can normally use events within Branch. This includes dashboard visualizations, Data Feeds (including Data Integrations, Query API, Webhooks, and Data Export API), Universal Ads postbacks, Journeys targeting, Liveview and more.
Attribution for logged out users on web¶
Branch uses a custom, in-house identifier for logged out users on web. If you enable the server to server integration from mParticle to Branch, you will not be able to attribute logged out web events to a campaign run with Branch. For this reason, you may want to track web events directly with the Branch web SDK, while still sending app events server to server from mParticle. Branch allows you to then toggle web event import off to prevent duplicate data.