Android SDK Initialization

Enable Custom Manifest File

Navigate to Build Settings and switch the platform to Android. Then go to Player Settings --> Player --> Android --> Publishing Settings.
Under the Build Heading check Custom Main Manifest.


Adding Dependencies

MoEngage plugin depends on the following Jetpack libraries. In case you don't have them in your application already, please add them.
You can choose to enable the custom gradle template in your Application's Player Settings and the below dependencies.


Add Application Class

  • Create a Java/Kotlin class and add it to the Assets --> Plugins --> Android folder. Extend the class with and override the onCreate().
  • Declare the above-created class in the Manifest file inside the application tag.
<application android:name="[FULLY_QUALIFIED_NAME_OF_APPLICATION_CLASS]">

The Manifest file can be found in the Assets--> Plugins --> Android folder.

SDK Initialization

Get the Workspace ID from the Settings Page Dashboard --> Settings --> Workspace --> General on the MoEngage dashboard and initialize the MoEngage SDK in the Application class's onCreate() method.



It is recommended that you initialize the SDK on the main thread inside onCreate() and not create a worker thread and initialize the SDK on that thread.

Kotlin Java
import com.moengage.unity.wrapper.MoEInitializer
import com.moengage.core.MoEngage
import com.moengage.core.DataCenter // this is the instance of the application class and "YOUR_Workspace_ID" is the Workspace ID from the dashboard. val moEngage = MoEngage.Builder(this, "YOUR_Workspace_ID",[YOUR_DATA_CENTER]) MoEInitializer.initialize(getApplicationContext(), moEngage)

Following details of the different data centers you need to set based on the dashboard hosts

Data Center Dashboard host






For more information about the detailed list of possible configurations, refer to the API reference.



All the configurations are added to the builder before initialization. If you are calling initialize at multiple places, ensure that all the required flags and configurations are set each time you initialize to maintain consistency in behavior.


Exclude MoEngage Storage File from Auto-Backup

This is a mandatory integration step and is very essential to prevent your data from getting corrupted. Android's auto back-up service periodically backs up Shared Preference files, Database files, etc, more details here. This backup results in MoEngage SDK's identifiers being backed up and restored after re-install.This restoration of the identifier results in your data being corrupted and users not being reachable via push notifications.

To ensure data is not corrupted after a backup is restored, opt out of MoEngage SDK's storage files. Refer to Exclude MoEngage Storage File from the Auto-Backup section of the documentation to learn more about which files to exclude.



Was this article helpful?
0 out of 0 found this helpful

How can we improve this article?