MoEngage Destination

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, the settings are propagated instantly.

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

To setup MoEngage do the following :

1. First get your key(AppID) from the MoEngage dashboard. Navigate to Dashboard > Settings > App > General.
2. In 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 Step 1.
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.

Segment-MoEngage Integration is a bundled integration and requires client-side integration.

Expand image

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.

The Identify method follows the format below:

1
analytics.identify('12090000-00001992', {
2
  name: 'John Doe',
3
  email: 'john.doe@example.com'
4
});

Use Track to track events and user behavior in your app.

1
analytics.track('Article Completed', {
2
  title: 'How to Create a Tracking Plan',
3
  course: 'Intro to Analytics',
4
});

This sends the event to MoEngage with the associated properties. Tracking events is essential and helps you create segments for engaging users.

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

analytics.reset();

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

To install with SPM use the MoEngage-Segment-Swift library and set the branch as master or version as 1.0.0 and above.

Head to the App Delegate file, and setup the Segment SDK by:

1. Importing Segment, Segment_MoEngage and MoEngageSDK.
2. Initialize MoEngageSDKConfig object and call initializeDefaultInstance method of MoEngageInitializer.
3. Initialize MoEngageDestination:

Under your Analytics-Swift library setup, add the MoEngage plugin using the analytics.add(plugin: ...) method. The MoEngage dashboard now tracks all of your events.

1
let analytics = Analytics(configuration: Configuration(writeKey: "<YOUR WRITE KEY>")
2
                    .flushAt(3)
3
                    .trackApplicationLifecycleEvents(true))
4
analytics.add(plugin: MoEngageDestination())

User attributes are specific traits of a user, like email, username, mobile, gender, and more. 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.

Analytics.main.identify("a user's id", traits: @["email":"a user's email address"])

Read more about Identify calls for further detail.

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.

Analytics.main.track("Item Purchased", properties: @["item":"Sword of Heracles"])

Read more about Track calls for further detail.

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.

Analytics.main.reset()

Read more about the Reset method for further detail.

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 following methods:

1
//For new Install call following
2
MoEngageSDKAnalytics.sharedInstance.appStatus(.install)
3

4
//For an app update call following
5
MoEngageSDKAnalytics.sharedInstance.appStatus(.update)

Read more on Install/Update differentiation on MoEngage website.

By default, the data center setting in the SDK is set to data_center_01. Follow the steps in the MoEngage - Data Center to update the data center value. If not set correctly, several features of the MoEngage SDK won't function.

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

Push notifications are a useful 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. In your application's application:didRegisterForRemoteNotificationsWithDeviceToken: method, add the following:

 Analytics.main.registeredForRemoteNotifications(deviceToken: deviceToken)

2. In your application's application:didReceiveRemoteNotification: method, add the following:

Analytics.main.receivedRemoteNotification(userInfo: userInfo)

3. If you integrated the application:didReceiveRemoteNotification:fetchCompletionHandler: in your app, add the following to that method:

Analytics.main.receivedRemoteNotification(userInfo: userInfo)

4. If you implemented handleActionWithIdentifier:forRemoteNotification:, add the following to that method:

Analytics.main.handleAction(identifier: identifier, userInfo: userInfo)

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

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.

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.

To make the app compliant with policies (such as GDPR) while using MoEngage's SDK, follow the instructions in MoEngage's documentation.

For more info on using Segment for iOS, refer to the Developer docs provided by Segment.

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

To enable the full functionality of MoEngage (like push notifications, in-app messaging), complete the following steps in your Android app.

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

1
implementation("com.moengage:moengage-segment-kotlin-destination:$sdkVersion") {
2
        transitive = true
3
    }

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

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

1
    implementation("androidx.core:core:1.6.0")
2
    implementation("androidx.appcompat:appcompat:1.3.1")
3
    implementation("androidx.lifecycle:lifecycle-process:2.4.0")

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

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

import com.segment.analytics.kotlin.destinations.moengage.MoEngageDestination

Add the following line:

1
Analytics("<YOUR WRITE KEY>", context)
2
  .add(MoEngageDestination(application))

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

1
// This is the instance of the application class and "YOUR_APP_ID" is the APP ID from the dashboard.
2
      val moEngage = MoEngage.Builder(this, "YOUR_APP_ID")
3
          .enablePartnerIntegration(IntegrationPartner.SEGMENT)
4
          .build()
5
      MoEngage.initialiseDefaultInstance(moEngage)

The auto-backup service of Android periodically backs up the Shared Preference file, Database files, and so on.

For more information, refer to the Auto-Backup documentation.

As a result of the backup, MoEngage SDK identifiers are backed up and restored after re-install. The restoration of the identifier results in your data being corrupted and the user not being reachable using push notifications.

To ensure data isn't corrupted after a backup is restored, opt-out of MoEngage SDK storage files.

Refer to the MoEngage documentation for further details.

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. An example call:

 MoEAnalyticsHelper.setAppStatus(context, AppStatus.UPDATE)

If this is a fresh install:

MoEAnalyticsHelper.setAppStatus(context, AppStatus.INSTALL)

Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. To upload it, go to the Settings page, Dashboard > Settings > Channel > Push > Mobile Push > Android and add the Server Key and package name. Ensure that you add the keys both in Test and Live environment.

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.

1
      val moEngage = MoEngage.Builder(this, "YOUR_APP_ID")
2
          .enablePartnerIntegration(IntegrationPartner.SEGMENT)
3
          .configureNotificationMetaData(NotificationConfig(
4
              smallIcon = R.drawable.small_icon,
5
              largeIcon = R.drawable.large_icon
6
          ))
7
          .build()
8
      MoEngage.initialiseDefaultInstance(moEngage)

To show push notifications there are two 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.

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

1
      val moEngage = MoEngage.Builder(this, "YOUR_APP_ID")
2
          .enablePartnerIntegration(IntegrationPartner.SEGMENT)
3
          .configureNotificationMetaData(NotificationConfig(
4
              smallIcon = R.drawable.small_icon,
5
              largeIcon = R.drawable.large_icon
6
          ))
7
          .configureFcm(FcmConfig(false))
8
          .build()
9
      MoEngage.initialiseDefaultInstance(moEngage)

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 following API to pass the push token to the MoEngage SDK.

MoEFireBaseHelper.getInstance().passPushToken(applicationContext,token)

Ensure that the 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.

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, check if the payload is from the MoEngage platform using the helper API provided by the SDK.

1
if (MoEPushHelper.getInstance().isFromMoEngagePlatform(remoteMessage.data)) {
2
    MoEFireBaseHelper.getInstance().passPushPayload(applicationContext, remoteMessage.data)
3
 } else {
4
    // your app's business logic to show notification
5
 }

Add the following code in your manifest file:

1
<service android:name="com.moengage.firebase.MoEFireBaseMessagingService">
2
 	<intent-filter>
3
		<action android:name="com.google.firebase.MESSAGING_EVENT" />
4
 	</intent-filter>
5
</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.

Segment recommends that you add the callbacks in the onCreate() of the application class since these callbacks can be triggered even when the application is in the background.

When MoEngage SDK handles push registration, it optionally provides a callback to the application whenever a new token is registered or the token is refreshed. To get the token callback implement the TokenAvailableListener and register for the callback using MoEFireBaseHelper.getInstance().addTokenListener().

If you're using the receiver provided by the SDK in your application's manifest file, SDK provides a callback in case a push payload is received for any other server apart from MoEngage Platform. To get a callback implement the NonMoEngagePushListener and register for the callback using MoEFireBaseHelper.getInstance().addNonMoEngagePushListener().

A rich landing page can be used to open a web URL inside the app through a push campaign.

The following configuration is only required if you want to add a parent activity to the Rich landing page. If not, you can move to the next section. To use a rich landing page you need to add the below code in the AndroidManifest.xml

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

1
<activity
2
  android:name="com.moe.pushlibrary.activities.MoEActivity"
3
  android:label="[ACTIVITY_NAME]"
4
  android:parentActivityName="[PARENT_ACTIVITY_NAME]" >
5
</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:

• Push Notifications
• Location Triggered
• In-App messaging
• Notification Center
• API Reference
• Compliance
• Release Notes

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.

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

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

Refer to MoEngage's GitHub repository for sample implementation.

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.

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:

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

• manifest.json
• serviceworker.js

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

1
<head>
2
  ...
3
	<link rel="manifest" href="/manifest.json">
4
  ...
5
</head>

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:

1
{
2
  ...
3
  "gcm_sender_id": "GCM_SENDER_ID",
4
  ...
5
}

2. Service Worker - Add the following line to the top of your serviceworker.js file.

1
importScripts("//cdn.moengage.com/webpush/releases/serviceworker_cdn.min.latest.js?date="+
2
new Date().getUTCFullYear()+""+new Date().getUTCMonth()+""+new Date().getUTCDate());

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.

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

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

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.

For information about optional features, see the documentation below:

• Configure opt-in type
• Self-handled opt-ins
• SDK callbacks

On-site messaging campaigns allow you to show personalized pop-ups and non-intrusive banners on your website.

Web SDK integration for On-site Messaging automatically starts working on all the pages where the web SDK is integrated.

For more information, refer to Configure and Integrate On-site Messaging.

Web personalization is used to personalize the website experience for each user. A few popular use cases for web personalization include the home page banner personalization basis user behavior, localizing the website content basis user geography, testing the performance of new page layouts for improved performance, modifying the content shown on any webpage as per the user behavior.

For more information, refer to MoEngage's documentation on how to configure and integrate web personalization.

You can send Computed traits and Audiences to MoEngage as custom attributes or custom events.

• Traits and audiences sent using the Identify call appear in MoEngage as Tracked Custom Attributes with value as True.
• Traits and audiences sent using the Track call appear in MoEngage as Tracked User Events.

When connecting the calculated trait or audience to the MoEngage destination, you can select the method of your choice (or opt to use both).

The default integration for MoEngage <> Twilio Engage connection is Real Time. But there are some filters that disqualify the persona from syncing in real-time, including some time-based filters which restrict your audience's size at the time of message send.

To generate custom attributes in MoEngage, you may provide Computed Traits defined in Engage as Identify calls. The computed trait's value is used to set the custom attribute.

1. In Segment, navigate to the Computed Traits in Engage.

2. Click New Computed Trait.

3. Create your computed trait. A lightning bolt in the top corner of the page will indicate if the computation updates in real-time.

   Expand image

4. Next, select MoEngage as your destination.

   Expand image

5. Preview by clicking Review & Create.

   By default, Segment queries all historical data to set the current value of the computed trait and audience. To omit this data, uncheck Historical Backfill.

   Expand image

6. In the computed trait, adjust the connection settings based on how you would like your data sent to MoEngage.

1. In Segment, navigate to the Audience in Engage.

2. Click New.

3. Create your audience. A lightning bolt indicates if the computation updates in real-time.

   Expand image

4. Next, select MoEngage as your destination.

   Expand image

5. Preview your audience by clicking Review & Create.

   By default, Segment queries all historical data to set the current value of the audience. To omit this data, uncheck Historical Backfill.

   Expand image

6. In the computed trait or audience settings, adjust the connection settings based on how you would like your data sent to MoEngage.

   Expand image

First, link MoEngage to Twilio Engage to send Computed Traits or Audiences. The first time you generate new Computed Trait or Audience, you can choose MoEngage as the destination for the Engage data.

1. Go to the Destinations tab in your space.
2. Search for MoEngage and add the MoEngage Destination to your Space.
3. On the set up screen, enter your App Id, App Key, and your Endpoint Region.

To create a segment of these users, navigate to Segments > Create Segment. Next, based on which call you used:

• Identify: Select User Property and select the specific attribute.

  Expand image

• Track: Select User Behaviour and select the specific event.

  Expand image

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