MoEngage Destination

MoEngage quick info

MoEngage accepts Identify, and Track calls. If you reference it in the Integrations object, call it “MoEngage”.

MoEngage accepts device-mode data from both Analytics.js and mobile sources. It does not accept data in cloud-mode. You can change the MoEngage connection mode for Analytics.js sources from the destination settings in the Segment web app.

Getting Started

Once you add the Segment-MoEngage library to your app, you can enable MoEngage from the Segment App. These new settings can take up to an hour to propagate to your existing users. For new users, it’ll be instantaneous!

The Segment-MoEngage Integration is a bundled integration, meaning it requires that you add a client-side integration to your app.

Setup MoEngage in your Segment Workspace:

To setup MoEngage do the following :

  1. First get your key(AppID) from the MoEngage dashboard.
  2. Go to your Segment workspace, go to Destinations and select MoEngage.
  3. Enable the MoEngage Destination.
  4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in Step1.
  5. Save the changes.
  6. Make sure you set the Connection Mode to Device Mode. MoEngage requires this setting to use of features like push notifications and any in-app features of the MoEngage SDK.

These new settings will take up to an hour to propagate to your existing users. For new users it’ll be instantaneous! Segment-MoEngage Integration is a bundled integration, requires client side integration.

iOS

To get started with MoEngage on iOS, first integrate your app with the MoEngage-Segment-iOS library. You can integrate MoEngage and Segment with CocoaPods.

  • Initialize pod with pod init command, this will create a podfile for your project.
  • Update your podfile by adding pod ‘Segment-MoEngage’ as shown below:
  use_frameworks!
  pod 'Segment-MoEngage
  • Update the pod.
pod update

Configure the Segment SDK:

Now head to the App Delegate file, and setup the Segment SDK by adding SEGMoEngageIntegrationFactory instance to the SEGAnalyticsConfiguration as shown below:

 #import <SEGMoEngageIntegrationFactory.h> // This line is key for MoEngage integration
 #import <SEGAnalytics.h>

 - (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions {

    // Add your configuration key from Segment
    SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"configuration key"];

    // Add MoEngageIntegrationFactory. Without this data will not come to MoEngage.
    [config use:[SEGMoEngageIntegrationFactory instance]];
    [SEGAnalytics setupWithConfiguration:config];
  }

Tracking User Attribute

User attributes are specific traits of a user, like email, username, mobile, gender etc. identify lets you tie a user to their actions and record traits about them. It includes a unique User ID and any optional traits you know about them.

 [[SEGAnalytics sharedAnalytics] identify:@"a user's id" traits:@{ @"email": @"a user's email address" }];

Read more about identify calls.

Tracking Events

Segment uses event tracking to track user behavior in an app. track calls let you record the actions your users perform. Every action triggers an “event”, which can also have associated attributes.

 [[SEGAnalytics sharedAnalytics] track:@"Item Purchased" properties:@{ @"item": @"Sword of Heracles"}];

Read more about track calls.

Reset Users

The reset method clears the SDK’s internal stores for the current user. This is useful for apps where users can log in and out with different identities over time.

 [[SEGAnalytics sharedAnalytics] reset];

Read more about the reset method.

Install / Update Differentiation

Since your app might already be on the App Store, you must specify whether your app update would be an UPDATE or an INSTALL. To differentiate between those, use one of the method below:

 //For new Install call following
 [[MoEngage sharedInstance] appStatus:INSTALL];

 //For an app update call following
 [[MoEngage sharedInstance] appStatus:UPDATE];

Read more on install/update differentiation.

Set the data center

By default, the data center setting in the SDK is set to DATA_CENTER_01. Follow the steps in the MoEngage - Data Redirection to update the data center value. If not set correctly, several features of the MoEngage SDK will not function.

Using features provided in the MoEngage SDK

Along with tracking your user’s activities, you can use the MoEngage iOS SDK for more effective user engagement:

Push Notifications:

Push Notifications are a great way to keep your users engaged and informed about your app. You have following options while implementing push notifications in your app:

Segment Push Implementation:

  1. Follow the directions to register for push notifications with the Segment SDK.

  2. In your application’s application:didReceiveRemoteNotification: method, add the following:
      [[SEGAnalytics sharedAnalytics] receivedRemoteNotification:userInfo];
    
  3. If you integrated the application:didReceiveRemoteNotification:fetchCompletionHandler: in your app, add the following to that method:
      [[SEGAnalytics sharedAnalytics] receivedRemoteNotification:userInfo];
    
  4. If you implemented handleActionWithIdentifier:forRemoteNotification:, add the following to that method:
      [[SEGAnalytics sharedAnalytics] handleActionWithIdentifier:identifier forRemoteNotification:userInfo];
    

MoEngage Push Implementation: For information about the MoEngage push implementation, see Push Notifications in the MoEngage documentation.

In-app messaging

In-App Messages are custom views which you can send to a set of users to show custom messages, give new offers, or direct to a specific page. For more information about In-app messaging, see MoEngage - In-App NATIV

Cards

Create targeted or automated App Inbox/NewsFeed messages that can be grouped into various categories, and target your users with different updates or offers that can stay in the Inbox/Feed over a designated period of time. For more information about cards, see MoEngage - Cards.

Compliance

To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this link.

Segment Docs

For more info on using Segment for iOS refer to Developer Docs provided by Segment.

Android

To use MoEngage in an Android app, you must perform the following steps to set up your environment.

MavenBadge

To enable the full functionality of MoEngage (like Push Notifications, InApp Messaging), complete the following steps in your Android app.

Adding the MoEngage Dependency

Along with the Segment dependency, add the below dependency in your build.gradle file.

 implementation("com.moengage:moengage-segment-integration:$sdkVersion") {
        transitive = true
    }

with $sdkVersion replaced by the latest version of the MoEngage SDK.

The MoEngage SDK depends on the below Jetpack libraries provided by Google for its functioning, make you add them if not done already.

    implementation("androidx.core:core:1.3.1")
    implementation("androidx.appcompat:appcompat:1.2.0")
    implementation("androidx.lifecycle:lifecycle-process:2.2.0")

Refer to the SDK Configuration documentation to know more about the build config and other libraries used by the SDK.

Register MoEngage with Segment SDK

After adding the dependency, you must register the integration with Segment SDK. To do this, import the MoEngage integration:

import com.segment.analytics.android.integrations.moengage.MoEngageIntegration;

Add the following line:

Analytics analytics = new Analytics.Builder(this, "write_key")
                .use(MoEngageIntegration.FACTORY)
                .build();

Initialize the MoEngage SDK

Copy the APP ID from the Settings Page Dashboard --> Settings --> App --> General and initialize the MoEngage SDK in the onCreate method of the Application class

Note: MoEngage recommend that you initialize the SDK on the main thread inside onCreate() and not create a worker thread and initialize the SDK on that thread.

// this is the instance of the application class and "XXXXXXXXXXX" is the APP ID from the dashboard.
MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXXX")
            .enableSegmentIntegration()
            .build();
MoEngage.initialize(moEngage);

Install or update differentiation

This is required for migrations to the MoEngage Platform so the SDK can determine whether the user is a new user on your app, or an existing user who updated to the latest version.

If the user was already using your application and has just updated to a new version which has the MoEngage SDK, below is an example call:

MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.UPDATE);

If this is a fresh install:

MoEHelper.getInstance(getApplicationContext()).setAppStatus(AppStatus.INSTALL);

Configure Push Notifications

Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. For more information about retrieving the Server Key, see MoEngage - Getting FCM Server Key. To upload it, go to the Settings Page Dashboard --> Settings --> Channel --> Push --> Mobile Push --> Android and add the Server Key and package name. Please make sure you add the keys both in Test and Live environment.

Add meta information for push notification

To display push notifications, some metadata regarding the notification is required. For example, the small icon and large icon drawables are mandatory.

Refer to the MoEngage - NotificationConfig API reference for all the possible options.

Use the configureNotificationMetaData() to pass on the configuration to the SDK.

MoEngage moEngage =
        new MoEngage.Builder(this, "XXXXXXXXXX")
            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true))
            .enablePartnerIntegration(IntegrationPartner.SEGMENT)
            .build();
MoEngage.initialize(moEngage);

Configuring Firebase Cloud Messaging

For showing Push notifications there are 2 important steps:

  1. Registration for Push, for example generating push token.
  2. Receiving the Push payload from Firebase Cloud Messaging(FCM) service and showing the notification on the device.
Push registration and receiving handled by the application
Opt-out of MoEngage registration

To opt-out of MoEngage token registration mechanism disable token registration while configuring FCM in the MoEngage.Builder as shown below

MoEngage moEngage = new MoEngage.Builder(this, "XXXXXXXXXX")
            .configureNotificationMetaData(new NotificationConfig(R.drawable.small_icon, R.drawable.large_icon, R.color.notiColor, "sound", true, true, true))
            .configureFcm(FcmConfig(false))
            .enablePartnerIntegration(IntegrationPartner.SEGMENT)
            .build();
MoEngage.initialize(moEngage);
Pass the push token to the MoEngage SDK

The Application must pass the Push Token received from FCM to the MoEngage SDK for the MoEngage platform to send out push notifications to the device. Use the below API to pass the push token to the MoEngage SDK.

MoEFireBaseHelper.getInstance().passPushToken(getApplicationContext(), token);

Please make sure token is passed to MoEngage SDK whenever push token is refreshed and on application update. Passing token on application update is important for migration to the MoEngage Platform.

Passing the Push payload to the MoEngage SDK

To pass the push payload to the MoEngage SDK call the MoEngage API from the onMessageReceived() from the Firebase receiver. Before passing the payload to the MoEngage SDK you should check if the payload is from the MoEngage platform using the helper API provided by the SDK.

if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.getData())) {
  MoEFireBaseHelper.Companion.getInstance().passPushPayload(getApplicationContext(), remoteMessage.getData());
}else{
  // your app's business logic to show notification
}
Push Registration and Receiving handled by SDK

Add the below code in your manifest file.

<service android:name="com.moengage.firebase.MoEFireBaseMessagingService">
 	<intent-filter>
		<action android:name="com.google.firebase.MESSAGING_EVENT" />
 	</intent-filter>
</service>

When the MoEngage SDK handles push registration, it optionally provides a callback to the Application whenever a new token is registered or the token is refreshed.

An application can get this callback by implementing FirebaseEventListener and registering for a callback in the Application class onCreate() using MoEFireBaseHelper.getInstance().addEventListener()

Refer to the MoEngage - API reference for more details on the listener.

Declare and configure Rich Landing Activity:

Add the following snippet and replace [PARENT_ACTIVITY_NAME] with the name of the parent activity; [ACTIVITY_NAME] with the activity name which should be the parent of the Rich Landing Page

<activity
  android:name="com.moe.pushlibrary.activities.MoEActivity"
  android:label="[ACTIVITY_NAME]"
  android:parentActivityName="[PARENT_ACTIVITY_NAME]" >
</activity>

You are now all set up to receive push notifications from MoEngage. For more information on features provided in MoEngage Android SDK refer to the following links:

Identify

Use Identify to track user-specific attributes. This is the same as tracking user attributes on MoEngage. MoEngage supports traits supported by Segment as well as custom traits. If you set traits.id, MoEngage sets that as the Unique ID for that user.

Track

Use track to track events and user behavior in your app. This will send the event to MoEngage with the associated properties. Tracking events is essential and will help you create segments for engaging users.

Reset

If your app supports the ability for a user to logout and login with a new identity, then you’ll need to call reset for the Analytics client.

Sample Implementation

Refer to this github repository for sample implementation

Web

The MoEngage WebSDK offers the ability to send push notifications to Google Chrome, Opera and Firefox browsers. Complete the following steps after you’ve configured Segment’s analytics.js.

Integration

1. Setup your MoEngage Web SDK settings at MoEngage Dashboard

Configure the web settings on the MoEngage dashboard to start using MoEngage <> Segment integration.

If you have selected HTTPS mode of integration in the settings, complete the following steps:

2 Set up for HTTPS websites

2.a Download the required files (HTTPS)

For HTTPS Web Push to work, you need to host two files in the root directory of your web server. These two files will be available for you to download at the web settings page.

  • manifest.json
  • serviceworker.js

Note: Please make sure the name of the serviceworker file is serviceworker.js. Please contact MoEngage support at support@moengage.com if you wish to have some other name for the serviceworker file.

Add the following line in the <head> tag of your page.

<head>
  ...
	<link rel="manifest" href="/manifest.json">
  ...
</head>

2.c Use your existing manifest or serviceworker file (HTTPS)

If you already have these files,

  1. Manifest - Add the sender ID you saved on MoEngage dashboard as the gcm_sender_id. If you’ve used MoEngage Shared Project while setting up, your sender id is 540868316921. Edit your manifest.json as follows:
      {
     ...
     "gcm_sender_id": "GCM_SENDER_ID",
     ...
      }
    
  2. Service Worker - Add the following line to the top of your serviceworker.js file
      importScripts("//cdn.moengage.com/webpush/releases/serviceworker_cdn.min.latest.js?date="+
      new Date().getUTCFullYear()+""+new Date().getUTCMonth()+""+new Date().getUTCDate());
    

Identify

Use Identify to track user specific attributes. This is equal to tracking user attributes on MoEngage. MoEngage supports traits supported by Segment as well as custom traits.

Track

Use track to track events and user behavior in your app. This will send the event to MoEngage with the associated properties. Tracking events is essential and will help you create segments for engaging users.

Reset

If your website supports the ability for a user to logout and login with a new identity, then you’ll need to call reset method in analytics.js.

Optional

For information about optional feature, see the documentation below:

Test Mode and Debugging

While updating the MoEngage settings on the Segment Dashboard, you can enable the logging functionality of the MoEngage SDK to see the SDK logs on the browser console. Just set Enable Debug Logging to On and the SDK loads in debug mode.

Note: When you enable debug mode, the events and attributes of the users send to the TEST environment of your MoEngage App.

Personas

You can send computed traits and audiences generated using Segment Personas to this destination as a user property. To learn more about Personas, contact us for a demo.

For user-property destinations, an identify call is sent to the destination for each user being added and removed. The property name is the snake_cased version of the audience name, with a true/false value to indicate membership. For example, when a user first completes an order in the last 30 days, Personas sends an Identify call with the property order_completed_last_30days: true. When the user no longer satisfies this condition (for example, it’s been more than 30 days since their last order), Personas sets that value to false.

When you first create an audience, Personas sends an Identify call for every user in that audience. Later audience syncs only send updates for users whose membership has changed since the last sync.

Supported Sources and Connection Modes

Before you start, make sure MoEngage supports the source type and connection mode you’ve chosen to implement. You can learn more about connection modes here.

Web Mobile Server
📱 Device-mode ⬜️
☁️ Cloud-mode ⬜️ ⬜️ ⬜️

Segment offers an optional Cloud-based Connection Mode for Web data with MoEngage. As a reminder, this removes the MoEngage javascript library from your site, improving performance.

Segment offers an optional Device-based Connection Mode for Mobile data going to MoEngage, so that you can use MoEngage features that collect data directly from the mobile device. To do this, you must package the Segment-MoEngage mobile SDK with the Segment mobile library.

Settings

Segment lets you change these destination settings from the Segment app without having to touch any code.

Setting Description
APP ID
(required)
string. You can find the APP_ID key under App Settings on the MoEngage dashboard. Please make sure you have uploaded the pem file for sending push on iOS and GCM Key for Android.
Enable Debug Logging
(required)
boolean, defaults to FALSE .

If you are in TEST mode and would like debug logs in your browser console, enable this setting. You should not have this option enabled for your production sources.
Direct Integration Channels array, defaults to server.

The channels this direct integration supports.
Direct Integration Endpoint string, defaults to https://api.moengage.com/v1/integrations/segment .

The API endpoint of the direct integration.

This page was last modified: 07 Jun 2021



Get started with Segment

Segment is the easiest way to integrate your websites & mobile apps data to over 300 analytics and growth tools.
or
Create free account