Customer.io Device Mode Integration

After you have successfully instrumented Customer.io as a destination in RudderStack, follow this guide to correctly send your events to Customer.io in device mode.

Add Customer.io integration

Make sure to add the Customer.io integration to your project before sending events to Customer.io in device mode.

Depending on your integration platform, follow these steps :

pod 'Rudder-CustomerIO', '~> 1.1.0'

RudderConfigBuilder *builder = [[RudderConfigBuilder alloc] init];
[builder withDataPlaneUrl:<DATA_PLANE_URL>];
[builder withFactory:[RudderCustomerIOFactory instance]];
[RudderClient getInstance:<WRITE_KEY>; config:[builder build]];

implementation 'com.rudderstack.android.sdk:core:[1.0,2.0)'
implementation 'com.rudderstack.android.integration:customerio:1.0.1'

<uses-permission android:name="android.permission.INTERNET" />
<uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />

// initialize Rudder SDK
val rudderClient: RudderClient =
    RudderClient.getInstance(
        this,
        WRITE_KEY,
        RudderConfig.Builder()
            .withDataPlaneUrl(DATA_PLANE_URL)
            .withFactory(CustomerIOIntegrationFactory.FACTORY)
            .build()
    )

Identify

The identify event lets you identify a visiting user and associate them to their actions. It also lets you record the traits about them like their name, email address, etc.

userId is a mandatory field for Customer.io. RudderStack drops the event if it is absent.

RudderStack sends the createdAt field (mapped to Customer.io’s created_at property) to register the user signup time. If it is absent in the event, RudderStack automatically assigns the event’s timestamp to created_at before sending it to Customer.io.

A sample identify call is shown below:

rudderanalytics.identify("userId", {
  name: "Tintin",
  city: "Brussels",
  country: "Belgium",
  email: "tintin@herge.com"
});

Note that:

• You cannot use the same email to make consecutive identify calls with different userId fields.
• To update user information, you can use the Customer.io canonical identifier cio_id, as shown:

rudderanalytics.identify('<cio_id>', {
  email: '<updated_email>@example.com',
  id: '<updated_id>'
});

Unsubscribe users

You can pass unsubscribed: true in the identify call to unsubscribe a user in Customer.io:

rudderanalytics.identify("27340af5c8819", {
  email: "alex@example.com",
  unsubscribed: true
});

Make sure the user ID and the email values match the Customer.io attributes. You can verify this by selecting that user in the People page in your Customer.io dashboard and clicking Attributes.

Track

The track event lets you record the user actions along with their associated properties and send them to Customer.io.

A sample track call is shown below:

rudderanalytics.track("Track me", {
  category: "category",
  label: "label",
  value: "value",
});

For anonymous users, Customer.io does not permit an event name of size more than 100 Bytes. RudderStack automatically trims the event name in such a scenario.

See the Customer.io documentation for more information on the Track API event limits.

Page

If you are using a native web SDK, RudderStack loads the Customer.io JavaScript snippet and captures the page views automatically.

You can also use the page event to record the page views along with the other page-related information.

A sample page call is as shown below:

// "Home" is the page name.
rudderanalytics.page("Home", {
  path: "path",
  url: "url",
  title: "title",
  search: "search",
  referrer: "referrer",
});

Screen

The screen event is the mobile equivalent of the page event and lets you record the screen views on your mobile app along with other relevant information about the viewed screen.

If you have enabled screen views in your app implementation in the iOS or Android SDK, RudderStack registers the screen views as Viewed <screen_name> Screen in the user’s Activities tab.

RudderStack also forwards the event properties to Customer.io as received.

A sample screen call using RudderStack’s iOS SDK is shown below:

[[RudderClient sharedInstance] screen:@"Main"
            properties:@{@"prop_key" : @"prop_value"}];

RudderStack transforms the above event as Viewed Main Screen before sending it to Customer.io.

Group

The group event lets you link an identified user with a group like a company, organization, or an account. It also lets you record any custom traits or properties associated with that group and send this information to Customer.io.

A sample group call is shown below:

rudderanalytics.group("group@49", {
  email: "help@rudderstack.com",
  action: "identify"
})

RudderStack automatically maps the following properties to the corresponding Customer.io properties:

Alias

The aliasevent lets you merge different identities of a known user. It is an advanced method that lets you change the tracked user’s ID explicitly.

The alias call is applicable only when both the user identities are present in Customer.io.

The mapping can be any one of the following:

• ID to ID
• email to email
• email to ID
• ID to email

A sample alias call is as shown below:

rudderanalytics.alias("userId", "previousId");

You can also merge two accounts via the user’s email address . RudderStack sets the primary email as userId and secondary email as previousId.

A sample alias call merging two accounts using the email address is shown:

rudderanalytics.alias("<primary.email>", "<secondary.email>");

Device token registration

RudderStack registers the device token to Customer.io for the below Application Lifecycle Events:

• Application Installed
• Application Opened

Enable the trackApplicationLifecycleEvents feature in your mobile SDK implementation code to use this feature.

Also, you need to register your device token after initializing the SDK. The following snippets demonstrate registering the device token for iOS and Android:

[[[RudderClient sharedInstance] getContext] putDeviceToken:[self getDeviceToken]];

RudderClient.putDeviceToken(getDeviceToken())

You can also specify the event name to be fired after setting the device token using the Event sent after setting device token dashboard setting.

Make sure to fire the event just after setting the device token in your app, so RudderStack can immediately register the device token to Customer.io and not delay until the next lifecycle event.

The following snippets highlight how to send a device_token_registered event after setting the device token in your app:

[[RSClient sharedInstance] track:@"device_token_registered"];

rudderClient!!.track("device_token_registered")

RudderStack also supports removing the device (identified by device_id) whenever you send a custom Application Uninstalled event.

Questions? Contact us by email or on Slack