mParticle

MParticle is a customer data platform (CDP) for omnichannel consumer brands, facilitating customer data management throughout the entire customer lifecycle. Its integration with Antavo enables brands to effectively synchronize customer data and actions.

This document outlines the process of configuring the connection between the two platforms and synchronizing events. Additionally, two use cases will be briefly discussed.

To access the configuration interface, navigate to the Modules menu and search for mParticle integration in the list.

Configuring the Antavo – mParticle connection

The module configuration requires an API URL, key, and secret to establish the connection. To retrieve this information from mParticle’s platform, follow these steps:

• Click the Setup menu item on the sidebar

• Proceed to the Inputs sub-menu
  The page will display available platforms.

• Navigate to the Feeds tab

• In the upper right corner, click the Add Feed Input dropdown and select Antavo

• A popup will appear for the Input feed configuration:

  • Provide a configuration name (mandatory)

  • Toggle the Feed status to active

  • Click Save

• After saving, the API key and secret will be visible

  

The next step is to configure the connection in Antavo’s Management UI.

• Return to the mParticle module’s configuration page

• Fill in the Connect mParticle form with the following details:

  • API URL: Enter https://inbound.mparticle.com/s2s/v2.

  • API key and API secret: Paste the API key and secret obtained from mParticle’s platform into the respective fields.

  • Development: Check this box if you want the synced data to be treated as development data and segregated from your production data.

• Click Connect

  

Field synchronization

Once the connection is established, proceed to configure the field synchronization between the two systems. This involved customer data synchronization and can be done under the Sync Fields page in Antavo’s Management UI.

• Click Add new field +

• The items in the left column’s dropdown called Loyalty fields show the fields within Antavo

• Remote fields represent the equivalent fields in mParticle

• Add more field mappings by inserting new rows at the bottom

• Click Save

The prefix ‘$’ before the remote field indicates that these properties are reserved attributes that trigger specific behaviors in mParticle’s platform. The following list contains these built-in attributes:

Custom user attributes can also be defined within Antavo without using the ‘$’ prefix. These will be created in mParticle’s system and can be viewed under the Data Master page, as seen in the example of the customer_id or language on the screenshot below.

External events

The mParticle module’s External events page allows you to configure custom events that can be pushed from Antavo to mParticle.

• Click Add association +

• In the left column’s dropdown labeled Antavo events, you’ll find the names of the events Antavo uses for various loyalty actions

• In the External events column, you can select the equivalent actions in mParticle

• Add new events by inserting new rows at the bottom

• Click Save

Refer to the use case at the end of this article for an example scenario illustrating the outcome of this event synchronization.

Resend queue

Antavo features a resend mechanism and a Resend queue page within the module, which queues outbound messages for delivery. A service automation is configured to attempt resending these messages up to five times, ultimately clearing the queue. Messages may be resent under the following conditions:

• failure due to a lost connection caused by a timeout

• failure due to hitting the rate limit of the customer’s mParticle account (HTTP response 429)

• failure due to an internal server error in mParticle

Event synchronization use cases

There are two methods for synchronizing Antavo events with mParticle. One approach involves configuring the synchronization within the Workflows module. The other method entails configuring the synchronization through the external events page within the mParticle module.

Point add synchronization and communication through the workflow editor

This example demonstrates setting up a workflow to trigger an automated email campaign when points are added to a customer.

Follow these steps to create this workflow:

• Open Workflows and click the Create new general workflow page

• Name the workflow and click Create

• Drag and drop the Event trigger node from the right sidebar onto the empty canvas

  • Specify the type of event on which the workflow should run. This should be configured to be triggered on a Point Add event so that this workflow activates whenever such an event occurs.

  • Click Update

  

• Scroll down to the actions and drag and drop the Trigger marketing communication node to the canvas

  • Enter point_add as the event name (mandatory)

  • Select the type of the event as it appears in mParticle (mandatory)

    Enter the key and value of the event data to be sent in the payload (the information about the event that needs to be sent to mParticle). Add multiple data fields to the payload using the Add button.

  • Click Update

Once points are added to a customer, you can verify the workflow outcome by checking the Workflow logs in Antavo’s Customer Insights pages. Additionally, if the Development mode checkbox is enabled, you can view the Live Stream in mParticle.

Reward claim synchronization through external events

To configure the event for a reward claim scenario, navigate to the External events page and provide the Field assignments. Select the appropriate event type, ensuring that when a customer claims a reward, the mPartivle event is triggered successfully.

You can verify the success of the event by checking the Live Stream log under the Data Master page, which should include the claimed reward’s ID.