MoEngage

https://help.moengage.com/hc/en-us/
Admin
MoEngage is a customer engagement platform that enables brands to build and manage transactional...
Tokens:1,254,708
Snippets:21,720
Trust Score:10
Update:5 months ago
Show doc for...
Tokens:
Raw
### SDK - IdentifyUser Function Example

Source: https://help.moengage.com/hc/en-us/articles/24050999467284-Unified-Identity-Identity-resolution

Illustrative example of using the `identifyUser()` function in SDKs to track users with multiple identifiers, such as email and ID.

```APIDOC
## SDK - IdentifyUser Function

### Description
The `identifyUser()` function, available in newer SDK versions (Android 13.6.00+, iOS 9.23.0+, WebSDK 2.52.2+), allows tracking users with multiple identifier attributes. It replaces the `SetUniqueID` function and requires identifiers to be pre-configured in MoEngage.

### Usage Example (Conceptual)
```javascript
// Example for WebSDK (conceptual)
moE.identifyUser({
  "email": "user@example.com",
  "id": "unique_user_id"
});
```

### Supported SDKs
- Android (13.6.00)
- iOS (9.23.0)
- WebSDK (2.52.2)
- GTM
- AMP
- ReactNative
- Flutter
```

--------------------------------

### Initialize MoEngage SDK in AppDelegate.m

Source: https://help.moengage.com/hc/en-us/articles/30022424310036-How-to-Avoid-Common-Push-Notification-Issues-on-iOS-Devices-Using-React-Native-Objective-C-and-MoEngage-iOS-SDK-Versions-7-x-x-8-x-x-9-x-x

Configure the MoEngage SDK within the application:didFinishLaunchingWithOptions method in AppDelegate.m. Ensure correct initialization for MoEngage SDK versions 7.x.x, 8.x.x, and 9.x.x, including options for SDK configuration objects.

```Objective-C
//7.xx
#import  

//8.xx
#import  
#import 

//9.xx
#import  
@import MoEngageSDK;

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

  UNUserNotificationCenter *center = [UNUserNotificationCenter currentNotificationCenter];
  center.delegate = self;
  
  [FIRApp configure]; //Firebase configuration syntx could differ according to versions
  
  //MoEngage Initializatoin - use specific version code only
  
  //7.xx version //Set MoEngage Properties in Info.plist
  [MoEngage setDataCenter:DATA_CENTER_0X];
  [MoEngage enableSDKLogs: true];
  [MoEngage setAppGroupID: @"group.com.XXXXXXXXXXXXXXXX"];
  [[MOReactInitializer sharedInstance] intializeSDKWithLaunchOptions:launchOptions];
  
  //7.xx version with sdkConfig
  MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID: @"XXXXXXXXXXXXXXXX"];
  sdkConfig.moeDataCenter = DATA_CENTER_0X;
  sdkConfig.appGroupID = @"group.com.XXXXXXXXXXXXXXXX";
  [[MOReactInitializer sharedInstance] intializeSDKWithConfig: sdkConfig andLaunchOptions: launchOptions];

  //8.xx version //Set MoEngage Properties in Info.plist
  [[MoEngageInitializer sharedInstance] initializeDefaultInstance: launchOptions];
  
  //8.xx version with sdkConfig
  MOSDKConfig* sdkConfig = [[MOSDKConfig alloc] initWithAppID:@"XXXXXXXXXXXXXXXX"];
  sdkConfig.enableLogs = true;
  sdkConfig.moeDataCenter = MODataCenterData_center_0X; 
  sdkConfig.appGroupID = @"group.com.XXXXXXXXXXXXXXXX";
  [[MoEngageInitializer sharedInstance] initializeDefaultSDKConfig:sdkConfig andLaunchOptions:launchOptions];
  
  //9.xx version //Set MoEngage Properties in Info.plist
  [[MoEngageInitializer sharedInstance] initializeDefaultInstance: launchOptions];
  
  //9.xx version with sdkConfig
  MoEngageSDKConfig* sdkConfig = [[MoEngageSDKConfig alloc] initWithAppId:@"XXXXXXXXXXXXXXXX" dataCenter: MoEngageDataCenterData_center_0X];
  MoEngageConsoleLogConfig *logConfig = [[MoEngageConsoleLogConfig alloc] initWithIsLoggingEnabled:YES loglevel:MoEngageLoggerTypeVerbose];
  sdkConfig.consoleLogConfig = logConfig;
  sdkConfig.appGroupID = @"group.com.XXXXXXXXXXXXXXXX";
  [[MoEngageInitializer sharedInstance] initializeDefaultSDKConfig:sdkConfig andLaunchOptions:launchOptions];
  
  // Rest of the implementation related to developer's app
  
  return YES;
}

```

--------------------------------

### Example: Full Name Field Validations

Source: https://help.moengage.com/hc/en-us/articles/33116671627924-Create-a-Channel-Connector-Config-File

This example demonstrates three validation rules for a 'Full Name' field: starting with an alphabet, allowed characters, and length constraints.

```json
"validations": [
    {
        "text": "Start the name with an alphabet",
        "regex": "^[A-Za-z]"
    },
    {
        "text": "Use only numbers, spaces, \"_\" or \"-\" with alphabets",
        "regex": "^[a-zA-Z0-9-_ ]*$"
    },
    {
        "text": "Use 3-25 characters",
        "regex": "^[a-zA-Z0-9 -_]{3,25}$"
    }
]
```

--------------------------------

### Get Daily Uninstalled Users Count per Platform

Source: https://help.moengage.com/hc/en-us/articles/360048049252-Key-Metrics-Queries-for-Open-Analytics

Segment daily uninstalled users by platform. This query uses the device uninstall event and user base table, filtering for users with 'false' install status.

```SQL
SELECT DATE(server_time) AS Date, os as Platform, COUNT(DISTINCT(user_id)) AS UsercountFROM account_name.device_uninstall_985WHERE day >= "2019-09-26 00:00:00" AND day <= "2019-09-27 00:00:00" AND user_id IN (  SELECT  DISTINCT(user_id)  FROM   account_name.user_base_table  WHERE   bool_installed_178 = "false" )GROUP BY 1, 2ORDER BY 1
```

--------------------------------

### Initiate a Live Activity

Source: https://help.moengage.com/hc/en-us/articles/44957826084628

Send an API request to MoEngage to initiate a Live Activity for a specific user. This requires the `live_activity_attributes` object with `la_type = "start"`, a unique `transaction_id`, and personalization attributes.

```APIDOC
## Initiate a Live Activity

### Description
Initiates a Live Activity for a specific user.

### Method
POST

### Endpoint
/v1/informs/live-activities

### Request Body
- **transaction_id** (string) - Required - A unique identifier for the Live Activity.
- **la_type** (string) - Required - Must be set to "start".
- **live_activity_attributes** (object) - Required - Contains personalization attributes for the Live Activity.
  - **attribute_name** (string) - Required - The name of the personalization attribute.
  - **value** (any) - Required - The value of the personalization attribute.

### Request Example
```json
{
  "transaction_id": "unique_transaction_123",
  "live_activity_attributes": {
    "la_type": "start",
    "attributes": {
      "order_id": "ORD98765",
      "delivery_eta": "30 minutes"
    }
  }
}
```

### Response
#### Success Response (200)
- **message** (string) - Confirmation message.

#### Response Example
```json
{
  "message": "Live Activity initiated successfully."
}
```
```

--------------------------------

### Configure 'Basic Auth' Authentication

Source: https://help.moengage.com/hc/en-us/articles/33116671627924-Create-a-Channel-Connector-Config-File

Set up 'basic_auth' by providing username and password references from the App Marketplace form. MoEngage will generate a Base64-encoded token.

```json
"auth": {
    "auth_type": "basic_auth",
    "auth_info": {
        "username": "{{AppMarketplaceForm["account_id"]}}",
        "password": "{{AppMarketplaceForm["account_key"]}}"
    },
    "alias": "valid_alias"
}
```

--------------------------------

### Example JSON Data for Snowflake

Source: https://help.moengage.com/hc/en-us/articles/18324470276884-Snowflake-Imports

This is an example of a valid JSON object that can be stored in a VARIANT column in Snowflake.

```json
{ "Designation": "SSE", "Palace": "Banglore", "age": 30, "name": "Shasha" }
```

--------------------------------

### Add MoEngage SDKs to Podfile

Source: https://help.moengage.com/hc/en-us/articles/31631630353812-How-to-Avoid-Push-Template-Issues-in-iOS-Push-Notifications-SDK-version-9-x-x-When-Notification-Content-Extension-is-Not-Implemented

Integrate the MoEngage-iOS-SDK and MoEngageRichNotification frameworks into your project's Podfile. Ensure 'use_frameworks!' is included if your main target uses it.

```ruby
target 'MoEngageDemo' do
  use_frameworks!
  pod 'MoEngage-iOS-SDK'
end

target 'MoEngageNotificationService' do
  use_frameworks! #use use_frameworks only if included in main target as in above scenario
  pod 'MoEngageRichNotification'
end

target 'MoegageRichContent" do
  use_frameworks! #use use_frameworks only if included in main target as in above scenario
  pod 'MoEngageRichNotification'
end
```
Tokens:
Raw