Overview

To streamline the integration process and minimize initialization errors, MoEngage supports Script-Based Initialization. This approach allows you to manage App IDs and configuration settings directly within native configuration files, keeping them separate from your application logic.

Script-based Initialization

Follow these steps to generate your initialization script:

1. Navigate to the Initialization Website.
2. Configure the values based on your application requirements. Refer to the Configuration Parameters tables below.
3. Click Generate Code at the bottom of the form.

Android Configuration (XML)

For Android, initialization is handled by placing an XML configuration file in the application's resource directory.

Android Configuration Reference

Below is the comprehensive list of keys available for moengage.xml.

Add Configuration File

Place the generated moengage.xml file in your Capacitor Android project at android/app/src/main/res/values/.

iOS Configuration (Info.plist)

For iOS, initialization is handled by adding a configuration dictionary to your Info.plist.

iOS Configuration Reference

Below is the comprehensive list of keys available for the MoEngage dictionary.

Data Center Values

Configure the integer corresponding to your region. Incorrect values will result in data loss. 

Update Info.plist

1. Open your project's Info.plist (found in ios/App/App/Info.plist).
2. Create a new Top-Level Key named MoEngage of type Dictionary.
3. Add the configuration file generated in the Initialization Website.

XML Snippet Representation:

<key>MoEngage</key>
<dict>
    <key>WorkspaceId</key>
    <string>YOUR_WORKSPACE_ID</string>
    <key>IsTestEnvironment</key>
    <string>$(SWIFT_ACTIVE_COMPILATION_CONDITIONS)|$(GCC_PREPROCESSOR_DEFINITIONS)</string>
    <key>DataCenter</key>
    <integer>1</integer>
    <key>CustomBaseDomain</key>
    <string>data.example.com</string>
    <key>IsLoggingEnabled</key>
    <true/>
</dict>

Framework Level Initialization

After you configure the native files, the initialization code in your hybrid framework is simplified.

Android Native Setup

Before initializing the SDK in JavaScript, you must initialize the native module in your Android Application class. Add the following code to android/app/src/main/java\<your\_package\>/MainApplication.java(or .kt) inside the onCreate() method.

import com.moengage.react.MoEInitializer;

@Override
public void onCreate() {
  super.onCreate();
  // ... existing code
  MoEInitializer.INSTANCE.initializeDefaultInstance(this);
}

import com.moengage.react.MoEInitializer

override fun onCreate() {
  super.onCreate()
  MoEInitializer.initializeDefaultInstance(application)
}

iOS Native Setup

Ensure your AppDelegate.swift triggers the SDK initialization using the default instance method, allowing it to read from your Info.plist.

import UIKit
import Capacitor

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {
    
    var window: UIWindow?
    
    func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey: Any]?) - Bool {
        
        MoECapacitorInitializer.sharedInstance.initializeDefaultInstance() 
        
        return true
    }
}

Initialize Capacitor Component

After native Android setup, initialize the plugin from your app entry or root component (e.g., app.component.ts, main.ts, or index.ts/js) of the bridge and initConfig is registered before you call other MoEngage Capacitor APIs.

import { MoECapacitorCore } from 'capacitor-moengage-core';

await MoECapacitorCore.initialize({
  appId: 'YOUR_WORKSPACE_ID',
  initConfig: {
    analyticsConfig: {
      shouldTrackUserAttributeBooleanAsNumber: true,
    },
    // Optional — omit if you do not need push click callbacks from JS
    pushConfig: {
      shouldDeliverCallbackOnForegroundClick: true,
    },
  },
  // Optional — queues some callbacks until app returns to foreground
  lifecycleAwareCallbackEnabled: false,
});

Migration and Precedence

To migrate from manual code-based initialization to the file-based approach, refer here.

Environments (Test vs. Live)

You can configure Test/Live environments within these files.

• Android: Use the key <string name="com_moengage_core_environment">test</string>.
• iOS: Use <key>IsTestEnvironment</key> <true/>