Skip to content

Commit a38fb16

Browse files
committed
Minor edits
1 parent 2c6951e commit a38fb16

File tree

1 file changed

+39
-39
lines changed
  • src/connections/destinations/catalog/moengage

1 file changed

+39
-39
lines changed

src/connections/destinations/catalog/moengage/index.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The Segment-MoEngage Integration is a bundled integration, meaning it requires t
1111
## Setup MoEngage in your Segment Workspace:
1212

1313
To setup MoEngage do the following :
14-
1. First get your key(AppID) from the MoEngage dashboard, `Dashboard --> Settings --> App --> General`.
14+
1. First get your key(AppID) from the MoEngage dashboard. Navigate to `Dashboard --> Settings --> App --> General`.
1515
2. Go to your **Segment workspace**, go to **Destinations** and select **MoEngage**.
1616
3. Enable the MoEngage Destination.
1717
4. Go to the MoEngage Settings and enter the MoEngage AppID, obtained in **Step1**.
@@ -27,27 +27,27 @@ users it’ll be instantaneous! Segment-MoEngage Integration is a bundled integr
2727
## iOS
2828

2929

30-
To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS) library. You can integrate MoEngage and Segment with [CocoaPods](http://cocoapods.org) or with Swift Package Manager.
30+
To get started with MoEngage on iOS, first integrate your app with the [MoEngage-Segment-iOS](https://github.com/moengage/MoEngage-Segment-iOS){:target="_blank"} library. You can integrate MoEngage and Segment with [CocoaPods](http://cocoapods.org){:target="_blank"} or with Swift Package Manager.
3131

3232
* Initialize pod with pod init command, this will create a podfile for your project.
3333
* Update your podfile by adding pod '**Segment-MoEngage**' as shown below:
3434

3535
```ruby
3636
use_frameworks!
37-
pod 'Segment-MoEngage
37+
pod 'Segment-MoEngage'
3838
```
3939

4040
* Update the pod.
4141

4242
pod update
43-
44-
43+
44+
4545
To install with SPM use the https://github.com/moengage/MoEngage-Segment-iOS.git and set the branch as master or version as 7.0.0 and above.
4646

4747
### Configure the Segment SDK:
4848

49-
Now head to the App Delegate file, and setup the Segment SDK by
50-
1. Importing `SEGMoEngageIntegrationFactory.h` and `SEGMoEngageInitializer.h`.
49+
Navigate to the App Delegate file, and setup the Segment SDK:
50+
1. Import `SEGMoEngageIntegrationFactory.h` and `SEGMoEngageInitializer.h`.
5151
2. Initialize `MOSDKConfig` object and call `initializeDefaultInstance:` method of `SEGMoEngageInitializer`.
5252
3. Initialize `SEGMoEngageIntegrationFactory` instance to the `SEGAnalyticsConfiguration` as shown below:
5353

@@ -61,7 +61,7 @@ Now head to the App Delegate file, and setup the Segment SDK by
6161
//Initialize SDKConfig object and call initializeDefaultInstance: method of SEGMoEngageInitializer
6262
MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID:@"YOUR APP ID"];
6363
[SEGMoEngageInitializer initializeDefaultInstance:sdkConfig];
64-
64+
6565
// Add your configuration key from Segment
6666
SEGAnalyticsConfiguration *config = [SEGAnalyticsConfiguration configurationWithWriteKey:@"configuration key"];
6767

@@ -117,11 +117,11 @@ To differentiate between those, use one of the method below:
117117
[[MoEngage sharedInstance] appStatus:AppStatusUpdate];
118118
```
119119
120-
Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620).
120+
Read more on [install/update differentiation](https://developers.moengage.com/hc/en-us/articles/4403910297620){:target="_blank"}.
121121
122122
### Set the data center
123123
124-
By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Redirection](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center) to update the data center value. If not set correctly, several features of the MoEngage SDK will not function.
124+
By default, the data center setting in the SDK is set to `data_center_01`. Follow the steps in the [MoEngage - Data Redirection](https://developers.moengage.com/hc/en-us/articles/4403910162452-Data-Center){:target="_blank"} to update the data center value. If not set correctly, several features of the MoEngage SDK will not function.
125125
126126
### Using features provided in the MoEngage SDK
127127
@@ -150,19 +150,19 @@ Push Notifications are a great way to keep your users engaged and informed about
150150
```
151151

152152
**MoEngage Push Implementation:**
153-
For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756) in the MoEngage documentation.
153+
For information about the MoEngage push implementation, see [**Push Notifications**](https://developers.moengage.com/hc/en-us/articles/4403943988756){:target="_blank"} in the MoEngage documentation.
154154

155155

156156
#### In-app messaging
157-
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](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ)
157+
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](https://developers.moengage.com/hc/en-us/articles/4404155127828-In-App-Nativ){:target="_blank"}.
158158

159159

160160
#### Cards
161-
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](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS).
161+
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](https://developers.moengage.com/hc/en-us/articles/4404058438676-Cards-in-iOS){:target="_blank"}.
162162

163163

164164
#### Compliance
165-
To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation).
165+
To make the App compliant with policies i.e,GDPR while using our SDK, follow the doc in this [link](https://developers.moengage.com/hc/en-us/articles/4403905438228-SDK-initialisation){:target="_blank"}.
166166

167167
### Segment Docs
168168
For more info on using **Segment for iOS** refer to [**Developer Docs**](/docs/connections/sources/catalog/libraries/mobile/ios/) provided by Segment.
@@ -195,7 +195,7 @@ The MoEngage SDK depends on the below Jetpack libraries provided by Google for i
195195
implementation("androidx.appcompat:appcompat:1.3.1")
196196
implementation("androidx.lifecycle:lifecycle-process:2.4.0")
197197
```
198-
Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration) documentation to know more about the build config and other libraries used by the SDK.
198+
Refer to the [SDK Configuration](https://developers.moengage.com/hc/en-us/articles/4401984733972-Android-SDK-Configuration){:target="_blank"} documentation to know more about the build config and other libraries used by the SDK.
199199

200200
### Register MoEngage with Segment SDK
201201

@@ -232,14 +232,14 @@ MoEngage.initialiseDefaultInstance(moEngage);
232232
### Exclude MoEngage Storage File from Auto-Backup
233233
Auto backup service of Andriod periodically backs up the Shared Preference file, Database files, and so on.
234234

235-
For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup).
235+
For more information, refer to [Auto Backup](https://developer.android.com/guide/topics/data/autobackup){:target="_blank"}.
236236

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

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

242-
Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup) for further details.
242+
Refer to the [documentation](https://developers.moengage.com/hc/en-us/articles/4401999257236-Exclude-MoEngage-Storage-File-from-Auto-Backup){:target="_blank"} for further details.
243243

244244
### Install or update differentiation
245245
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.
@@ -265,7 +265,7 @@ Copy the Server Key from the FCM console and add it to the MoEngage Dashboard. T
265265

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

268-
Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/com.moengage.core.config/-notification-config/index.html) API reference for all the possible options.
268+
Refer to the [MoEngage - NotificationConfig](https://moengage.github.io/android-api-reference/core/com.moengage.core.config/-notification-config/index.html){:target="_blank"} API reference for all the possible options.
269269

270270
Use the `configureNotificationMetaData()` to pass on the configuration to the SDK.
271271

@@ -341,26 +341,26 @@ When the MoEngage SDK handles push registration, it optionally provides a callba
341341

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

344-
Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference/moe-push-firebase/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html) for more details on the listener.
344+
Refer to the [MoEngage - API reference](https://moengage.github.io/android-api-reference/moe-push-firebase/moe-push-firebase/com.moengage.firebase.listener/-firebase-event-listener/index.html){:target="_blank"} for more details on the listener.
345345

346346
##### Callbacks
347347

348348
We recommend you to add the callbacks in the onCreate() of the Application class since these callbacks can be triggered even when the application is in the background.
349349

350350
###### Token Callback
351351

352-
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](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html).
352+
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](https://moengage.github.io/android-api-reference/pushbase/com.moengage.pushbase.listener/-token-available-listener/index.html){:target="_blank"} and register for the callback using [MoEFireBaseHelper.getInstance().addTokenListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-token-listener.html){:target="_blank"}.
353353

354354
###### Non-MoEngage Payload
355355

356-
If you are 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](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html) and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html).
356+
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](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase.listener/-non-mo-engage-push-listener/index.html){:target="_blank"} and register for the callback using [MoEFireBaseHelper.getInstance().addNonMoEngagePushListener()](https://moengage.github.io/android-api-reference/moe-push-firebase/com.moengage.firebase/-mo-e-fire-base-helper/add-non-mo-engage-push-listener.html){:target="_blank"}.
357357

358358

359359
#### Declare and configure Rich Landing Activity:
360360

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

363-
The below 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.
363+
The configuration below 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.
364364
To use a rich landing page you need to add the below code in the AndroidManifest.xml
365365

366366
Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of the parent
@@ -376,23 +376,23 @@ Add the following snippet and replace `[PARENT_ACTIVITY_NAME]` with the name of
376376

377377
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:
378378

379-
* [Push Notifications](https://developers.moengage.com/hc/en-us/sections/360013606771-Push)
379+
* [Push Notifications](https://developers.moengage.com/hc/en-us/sections/360013606771-Push){:target="_blank"}
380380

381-
* [Location Triggered](https://developers.moengage.com/hc/en-us/articles/4403443036564-Location-Triggered)
381+
* [Location Triggered](https://developers.moengage.com/hc/en-us/articles/4403443036564-Location-Triggered){:target="_blank"}
382382

383-
* [In-App messaging](https://developers.moengage.com/hc/en-us/sections/360013831431-In-App-Messages)
383+
* [In-App messaging](https://developers.moengage.com/hc/en-us/sections/360013831431-In-App-Messages){:target="_blank"}
384384

385-
* [Notification Center](https://developers.moengage.com/hc/en-us/articles/4403878923284-Notification-Center)
385+
* [Notification Center](https://developers.moengage.com/hc/en-us/articles/4403878923284-Notification-Center){:target="_blank"}
386386

387-
* [API Reference](https://moengage.github.io/android-api-reference/index.html)
387+
* [API Reference](https://moengage.github.io/android-api-reference/index.html){:target="_blank"}
388388

389-
* [Compliance](https://developers.moengage.com/hc/en-us/sections/4403894212116-Compliance)
389+
* [Compliance](https://developers.moengage.com/hc/en-us/sections/4403894212116-Compliance){:target="_blank"}
390390

391-
* [Release Notes](https://developers.moengage.com/hc/en-us/articles/4403896795540-Changelog)
391+
* [Release Notes](https://developers.moengage.com/hc/en-us/articles/4403896795540-Changelog){:target="_blank"}
392392

393393

394394
### Identify
395-
Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](http://docs.moengage.com/docs/identifying-user) 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.
395+
Use [Identify](/docs/connections/sources/catalog/libraries/mobile/android/#identify) to track user-specific attributes. This is the same as tracking [user attributes](http://docs.moengage.com/docs/identifying-user){:target="_blank"} 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.
396396

397397
### Track
398398
Use [track](/docs/connections/sources/catalog/libraries/mobile/android/#track) to track events and user behavior in your app.
@@ -403,7 +403,7 @@ If your app supports the ability for a user to logout and login with a new ident
403403

404404
### Sample Implementation
405405

406-
Refer to [this](https://github.com/moengage/moengage-segment-integration) Github repository for sample implementation
406+
Refer to [this](https://github.com/moengage/moengage-segment-integration){:target="_blank"} Github repository for sample implementation
407407

408408
## Web
409409

@@ -413,14 +413,14 @@ The MoEngage WebSDK offers the ability to send push notifications to Google Chro
413413
### Integration
414414

415415
#### 1. Setup your MoEngage Web SDK settings at MoEngage Dashboard
416-
Configure the [web settings](https://app.moengage.com/v3/#/settings/push/web) on the MoEngage dashboard to start using MoEngage <> Segment integration.
416+
Configure the [web settings](https://app.moengage.com/v3/#/settings/push/web){:target="_blank"} on the MoEngage dashboard to start using MoEngage <> Segment integration.
417417

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

420420
#### 2 Set up for HTTPS websites
421421

422422
#### 2.a Download the required files (HTTPS)
423-
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](https://app.moengage.com/v3/#/settings/push/web).
423+
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](https://app.moengage.com/v3/#/settings/push/web){:target="_blank"}.
424424
* manifest.json
425425
* serviceworker.js
426426

@@ -457,7 +457,7 @@ If you already have these files,
457457
```
458458

459459
### Identify
460-
Use [Identify](/docs/sources/website/analytics.js/#identify) to track user specific attributes. This is equal to [tracking user attributes](https://docs.moengage.com/docs/tracking-web-user-attributes) on MoEngage. MoEngage supports traits supported by Segment as well as custom traits.
460+
Use [Identify](/docs/sources/website/analytics.js/#identify) to track user specific attributes. This is equal to [tracking user attributes](https://docs.moengage.com/docs/tracking-web-user-attributes){:target="_blank"} on MoEngage. MoEngage supports traits supported by Segment as well as custom traits.
461461

462462
### Track
463463
Use [track](/docs/sources/website/analytics.js/#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.
@@ -467,9 +467,9 @@ If your website supports the ability for a user to logout and login with a new i
467467

468468
### Optional
469469
For information about optional feature, see the documentation below:
470-
* [Configure opt in type](https://docs.moengage.com/docs/configuring-notification-opt-in)
471-
* [Self-handled opt-ins](https://docs.moengage.com/docs/self-handled-opt-ins)
472-
* [SDK callbacks](https://docs.moengage.com/docs/tracking-opt-ins-on-your-own)
470+
* [Configure opt in type](https://docs.moengage.com/docs/configuring-notification-opt-in){:target="_blank"}
471+
* [Self-handled opt-ins](https://docs.moengage.com/docs/self-handled-opt-ins){:target="_blank"}
472+
* [SDK callbacks](https://docs.moengage.com/docs/tracking-opt-ins-on-your-own){:target="_blank"}
473473

474474
### Test Mode and Debugging
475475
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.

0 commit comments

Comments
 (0)