Build With RevenueCat

Build a customized mobile subscription business with RevenueCat. We do the heavy lifting of normalizing subscribers from any source and maintain a single source of truth for subscription status, so you can get back to building your app.

RevenueCat is a powerful, secure, reliable, and free to use in-app purchase server with global support. All you need to get started is an API key.

Get Started    API Reference

Segment

Integrate in-app subscription events from RevenueCat with Segment

👍

The Segment integration is only available on paid plans.

RevenueCat can automatically send subscription events into Segment. From there, you pass these events on to any of the hundreds of other integrations on their platform. This is useful for tracking all events and revenue that occur for your app even if it's not active for a period of time.

The Segment integration tracks the following events:

Event

Description

Initial Purchase

The first purchase of an auto-renewing subscription product that does not contain a free trial.

Trial Started

The start of an auto-renewing subscription product free trial.

Trial Converted

When an auto-renewing subscription product converts from a free trial to normal paid period.

Trial Cancelled

When a user turns off renewals for an auto-renewing subscription product during a free trial period.

Renewal

When an auto-renewing subscription product renews OR a user repurchases the auto-renewing subscription product after a lapse in their subscription.

Cancellation

When a user turns off renewals for an auto-renewing subscription product during the normal paid period.

Uncancellation

When a user re-enables the auto-renew status for a subscription.

Non Subscription Purchase

The purchase of any product that's not an auto-renewing subscription.

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

1. Set Segment user identity

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

Use the .identify() method on the Segment SDK to set the same App User Id that is set in RevenueCat.

// Configure Purchases SDK
Purchases.configure(withAPIKey: "public_sdk_key", appUserID: "my_app_user_id")

// Set App User Id in Segment
SEGAnalytics.sharedAnalytics().identify("my_app_user_id")
// Configure Purchases SDK
[RCPurchases configureWithAPIKey:@"public_sdk_key" appUserID:@"my_app_user_id"];

// Set App User Id in Segment
[[SEGAnalytics sharedAnalytics] identify:@"my_app_user_id"];
// Configure Purchases SDK
Purchases.configure(this, "public_sdk_key", "my_app_user_id");

// Set App User Id in Segment
Analytics.with(context).identify("my_app_user_id", null, null);

2. Generate a Segment Write Key

In Segment, add a HTTP API as a source and copy the Write Key.

3. Send RevenueCat events to Segment

After you've set up the Purchase SDK and Segment 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 app in the RevenueCat dashboard and choose 'Segment' from the integrations menu
  2. Add your Segment Write Key from step 2
  3. Enter the event names that RevenueCat will send or choose the default event names
  4. Select whether you want RevenueCat to report proceeds (after app store cut) or revenue (gross sales)
  5. Select whether you want RevenueCat to send sandbox events into Segment or not. You can check the environment key in the context property of the event to determine if it was triggered in a sandbox or production environment.

Segment configuration screen

Sample Event

Below is sample JSON that is delivered to Segment for a trial conversion event.

{
  "identify": {
    "context": {
      "environment": "production",
      "library": {
        "name": "RevenueCat Segment events",
        "version": "1.0"
      }
    },
    "timestamp": 1567511348,
    "traits": {
      "aliases": [
        "$rc_abcdefg12345",
        "myCustomAppUserId"
      ],
      "last_seen_app_user_id": "myCustomAppUserId"
    },
    "userId": "myCustomAppUserId"
  },
  "track_event": {
    "context": {
      "environment": "production",
      "library": {
        "name": "RevenueCat Segment events",
        "version": "1.0"
      }
    },
    "event": "trial_converted_event",
    "properties": {
      "app_user_id": "myCustomAppUserId",
      "currency": "USD",
      "entitlement": "your_entitlement_id",
      "expires_at": 1570103348,
      "original_app_user_id": "$rc_abcdefg12345",
      "product_id": "your_product_id",
      "revenue": 9.99,
      "store": "APP_STORE"
    },
    "timestamp": "2019-09-03T11:49:08",
    "userId": "myCustomAppUserId"
  }
}

Updated 6 months ago


Segment


Integrate in-app subscription events from RevenueCat with Segment

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.