CleverTap Unity Plugin

👋 Introduction

The CleverTap Unity Plugin for Mobile Customer Engagement and Analytics solutions.

For more information check out our website and documentation.

To get started, sign up here.

🛠 Installation and Setup

You can install the CleverTap Unity SDK using the .unitypackage Unity package or as a local package through Unity Package Manager (UPM).

Import the CleverTap Unity Package

1. Download the latest version of the CleverTap Unity package. Import the .unitypackage into your Unity Project. Go to Assets > Import Package > Custom Package.
2. Add the PlayServiceResolver and the ExternalDependencyManager folders. These folders will install the EDM4U plugin, which automatically adds all the Android and iOS dependencies when building your project.
3. Ensure that the scripts inside the Editor folder are added. The AndroidPostImport script sets up clevertap-android-wrapper library for Android. IOSPostBuildProcessor and AndroidProjectPostProcessor scripts helps iOS and Android setup.

Import the CleverTap Unity Package as a Local Dependency

Clone the latest release version of CleverTap Unity SDK. The SDK can be imported as a local package through the Unity Package Manager.

Set Up the Unity SDK

CleverTap API can be accessed anywhere in your project by simply calling the static CleverTap class. No need to create GameObject or attach any script. The SDK handles the following:

• Instantiation of platform-specific binding (iOS, Android, Native)
• Creation of GameObject
• Script attachment.

Use the Unity Editor CleverTap Settings dialog (Assets -> CleverTap Settings) to automatically set your account configuration for iOS and Android builds.

You can view your CleverTap Account ID and CleverTap Account Token from the CleverTap Dashboard -> Settings.

For Unity Native builds initialize the SDK with the following code:

// Initialize CleverTap
CleverTap.LaunchWithCredentialsForRegion({YOUR_CLEVERTAP_ACCOUNT_ID}, {YOUR_CLEVERTAP_ACCOUNT_TOKEN}, {CLEVERTAP_ACCOUNT_REGION});

Callbacks

Add an event listener for a callback directly through the CleverTap static events.

CleverTap.OnCleverTapDeepLinkCallback += YOUR_CALLBACK_METHOD;  
CleverTap.OnCleverTapProfileInitializedCallback += YOUR_CALLBACK_METHOD;  
CleverTap.OnCleverTapInAppNotificationButtonTapped += YOUR_CALLBACK_METHOD;

iOS Instructions

iOS specific setup is described in the iOS Instructions

Android Instructions

Android specific setup is described in the Android Instructions

WebGL Instructions

WebGL specific setup is described in the WebGL Instructions

💻 Example Usage

• See the CleverTap Unity Usage Documentation

🎮 Gaming

The SDK includes lifecycle controls designed for game loops:

• PauseSDK / ResumeSDK — Temporarily halt data collection during performance-critical gameplay. Events recorded while paused are buffered in memory and flushed automatically on resume, so no data is lost. Call PauseSDK() when entering an active match or level and ResumeSDK() when the player returns to a menu, lobby, or any screen where engagement tracking is meaningful.

void OnGameplayStart() => CleverTap.PauseSDK();
void OnGameplayEnd()   => CleverTap.ResumeSDK(); // buffered events flush here

See Usage Documentation for full details.

🆕 Changelog

Check out the CleverTap Unity plugin SDK Change Log here.

⁉️ Questions?

If you have questions or concerns, you can reach out to the CleverTap support team from the CleverTap Dashboard.

TroubleShooting Guide: Please refer here if you are facing common integration issue.