mParticle

Read time: 4 minutes

Last edited: Oct 16, 2024

Overview

This topic explains how to create and test an mParticle destination for Data Export.

mParticle is a customer data platform that allows you to aggregate your analytics and create customer cohorts.

Prerequisites

To set up an mParticle destination in LaunchDarkly, you need:

Your mParticle server-to-server key
Your mParticle server-to-server secret

The key and secret are available in your mParticle account. Copy and save both strings. You'll need them to connect mParticle to LaunchDarkly.

Here is an image of the mParticle API keys dialog:

Create the mParticle destination in LaunchDarkly

You can use the LaunchDarkly UI to create and modify destinations for Data Export.

To create an mParticle destination in LaunchDarkly:

Navigate to the Integrations page and find "mParticle."
Click Add integration. The "Create a destination" panel appears.
(Optional) Enter a Name for the destination.
Select a Project and environment for this destination to receive events from.

Environment settings are permanent

You cannot change an environment after you create the destination. If you wish to export event data from a different environment, you must set up another destination.

Select an mParticle Environment.
Enter your mParticle server-to-server key in the API key field.
Enter your mParticle server-to-server secret in the API secret field.
Click Add a mapping.
Select a LaunchDarkly Context.
Select an mParticle User Identifier.

Choose the correct user identifier for your events

The user identifier you choose must match an identifier you chose to identify users in the mParticle ecosystem.

Every event LaunchDarkly exports has a context key specified by the SDK. The user identifier should correspond to the mParticle user identity your SDK context key represents. For example, if your context key represents a customer ID, you should choose customer_id as the user identifier.

To learn more about exported events, read Schema reference.

Click Add mapping.
Check the checkbox indicating you consent to the Integration Terms and Conditions.
Click Save destination.

The mParticle destination appears in the "Your data export destinations" section of the Integrations screen.

Test an mParticle destination

After you save the destination, send a test event to confirm that the destination is configured properly.

To send a test event:

Navigate to the Integrations page and find "mParticle."
Click into the "mParticle" section to display a list of destinations.
Click the pencil icon next to the destination you want to test. The "Edit destination" panel appears.
In the "Send a test event" section, click Send event.
Verify the event appears on the mParticle events live stream.

Example events

These example events display the structure of the events LaunchDarkly sends to mParticle.

LaunchDarkly sends events in the following formats:

{
  "user_identities": {
    "customer_id": "EXAMPLE-CUSTOMER"
  },
  "environment": "EXAMPLE-ENVIRONMENT-NAME",
  "events": [
    {
      "event_type": "CUSTOM-EVENT",
      "data": {
        "source_message_id": "###-##",
        "event_name": "EXAMPLE-FEATURE-NAME",
        "timestamp_unixtime_ms": 1590697814783,
        "custom_event_type": "other",
        "custom_attributes": {
          "project": "EXAMPLE-PROJECT-NAME",
          "environment": "5d4b12345d2a2806bd2cc6eb",
          "version": "1",
          "key": "flag",
          "value": "true",
          "flag_version": "42",
          "default": "false",
          "reason_kind": "FALLTHROUGH",
          "prerequisite_of": "PARENT-FLAG",
          "event_type": "custom_event"
        }
      }
    }
  ]
}

Enable Data Export for flags and environments

After you create a Data Export destination, you must start sending flag or environment event data to it. You can enable Data Export for individual flags, or for all the flags in an environment.

To learn more, read Export event data for flags and environments

Delete an mParticle destination

You can delete a Data Export destination from the Integrations screen.

To delete a destination:

Navigate to the Integrations page and find "mParticle."
Click into the "mParticle" section to display a list of destinations.
Click the pencil icon next to the destination you wish to delete. The "Edit destination" panel appears.
Click Delete destination.