DocumentationREST APISamplesSDK ReferenceBlogGet Help
Sign upLog in



The mParticle integration is available on the [Pro](🔗) plan.

mParticle can be a useful integration tool for seeing all events and revenue that occur for your app even if it’s not active for a period of time. You can use mParticle to clean up your data infrastructure and collect new customer data, which can then be connected with other tools through mParticle’s powerful API.

With our mParticle integration, you can:

  • Use the API to identify users who are at risk of churning and begin a campaign to win them back.

  • Set up push notifications and emails to users who have subscribed to your product but do not engage very much.

With accurate and up-to-date subscription data in mParticle, you'll be set to turbocharge your campaigns ⚡️

# Events

The mParticle integration tracks the following events:

EventDefault Event NameDescriptionApp StorePlay StoreAmazonStripePromo
Initial Purchaseinitial_purchaseA new subscription has been purchased.✅✅✅✅❌
Trial Startedtrial_startedThe start of an auto-renewing subscription product free trial.✅✅✅✅❌
Trial Convertedtrial_convertedWhen an auto-renewing subscription product converts from a free trial to normal paid period.✅✅✅✅❌
Trial Cancelledtrial_cancelledWhen a user turns off renewals for an auto-renewing subscription product during a free trial period.✅✅✅✅❌
RenewalrenewalAn existing subscription has been renewed or a lapsed user has resubscribed.✅✅✅✅❌
CancellationcancellationA subscription or non-renewing purchase has been cancelled. See [cancellation reasons](🔗) for more details.✅✅✅✅✅
UncancellationuncancellationA non-expired cancelled subscription has been re-enabled.✅✅✅❌❌
Non Subscription Purchasenon_renewing_purchaseA customer has made a purchase that will not auto-renew.✅✅✅✅✅
ExpirationexpirationA subscription has expired and access should be removed. If you have [Platform Server Notifications](🔗) configured, this event will occur as soon as we are notified (within seconds to minutes) of the expiration. If you do not have notifications configured, delays may be approximately 1 hour.✅✅✅✅✅
Billing Issuesbilling_issueThere has been a problem trying to charge the subscriber. This does not mean the subscription has expired. Can be safely ignored if listening to CANCELLATION event + cancel_reason=BILLING_ERROR.✅✅✅✅❌
Product Changeproduct_changeA subscriber has changed the product of their subscription. This does not mean the new subscription is in effect immediately. See [Managing Subscriptions](🔗) for more details on updates, downgrades, and crossgrades.✅✅❌✅❌
RefundrefundWhen a user canceled their subscription via customer support✅✅✅✅❌

For events that have revenue, such as trial conversions and renewals, RevenueCat will automatically record this amount along with the event in mParticle.

# Setup

## 1. Set mParticle User Identity and Send Device Data to RevenueCat

If you're using the mParticle SDK, you can set the User ID to match the RevenueCat App User Id. This way, events sent from the mParticle SDK and events sent from RevenueCat can be synced to the same user.

The mParticle integration also requires some device-specific data. RevenueCat will only send events into mParticle if the below [Subscriber Attributes](🔗) keys have been set for the device.

KeyDescriptionRequired
`$mparticleId`The unique mParticle user identifier (mpid).✅ (recommended)
`$idfa`iOS [advertising identifier](🔗) UUID❌ (optional)
`$idfv`iOS [vender identifier](🔗) UUID❌ (optional)
`$gpsAdId`Google [advertising identifier](🔗)❌ (optional)
`$androidId`Android [device identifier](🔗)❌ (optional)
`$ip`The IP address of the device❌ (optional)

These properties can be set manually, like any other [Subscriber Attributes](🔗), or through the helper methods `collectDeviceIdentifiers()` and `setMparticleId()`.

Create an `identityRequest` and add it to the `MParticleOptions` that you pass to the `start()` method on the mParticle SDK to set the same App User Id that is set in RevenueCat.


mParticle also allows you to log a user in after starting the SDK and log a user out; you should handle both of these cases:


Device identifiers with iOS App Tracking Transparency (iOS 14.5+)
If you are requesting the App Tracking permission through ATT to access the IDFA, you can call `.collectDeviceIdentifiers()` _again_ if the customer accepts the permission to update the `$idfa` attribute in RevenueCat.
## 2. Add RevenueCat Feed Inputs in mParticle
In mParticle, add the RevenueCat feed input and create two feeds: one for the Android platform and one for the iOS platform. Copy each feed's Server to Server Key and Server to Server Secret for setup on RevenueCat. Refer to [mParticle's documentation](🔗) to learn more about feeds.


## 3. Send RevenueCat events to mParticle
After you've set up the _Purchases SDK_ and mParticle SDK to have the same user identity, you can "turn on" the integration and configure the event names from the RevenueCat dashboard.
  1. Navigate to your project in the RevenueCat dashboard and find the _Integrations_ card in the left menu. Select **+ New** 

  1. Choose **mParticle** from the Integrations menu
  2. Add your **Server to Server Keys** and **Server to Server Secrets** for each platform from step 2
  3. Enter the event names that RevenueCat will send or choose the default event names
  4. Select whether you want sales reported as gross revenue (before app store commission), or after store commission and/or estimated taxes.
## 4. Testing the mParticle integration
You can test the mParticle integration end-to-end before going live. It's recommended that you test the integration is working properly for new users, and any existing users that may update their app to a new version.
### Make a sandbox purchase with a new user
Simulate a new user installing your app, and go through your app flow to complete a sandbox purchase.
### Check that the required device data is collected
Navigate the the [Customer View](🔗) for the test user that just made a purchase. Make sure that all of the required data from step 1 above is listed as attributes for the user.

### Check that the mParticle event delivered successfully
While still on the Customer View, click into the test purchase event in the [Customer History](🔗) and make sure that the mParticle integration event exists and was delivered successfully. 

You've done it!
You should start seeing events from RevenueCat appear in mParticle
# Sample Events
Below are sample JSONs that are delivered to mParticle for the different event types.