Userpilot Flutter Plugin enables you to capture user insights and deliver personalized in-app experiences in real time. With just a one-time setup, you can immediately begin leveraging Userpilot’s analytics and engagement features to understand user behaviors and guide their journeys in-app.
This document provides a step-by-step walkthrough of the installation and initialization process, as well as instructions on using the SDK’s public APIs.
Prerequisites
Android
Your application’s build.gradle
must have a compileSdkVersion
of 34+ and minSdkVersion
of 21+, and use Android Gradle Plugin (AGP) 8+.
android {
compileSdkVersion 34
defaultConfig {
minSdkVersion 21
}
}
Due to the SDK usage of Jetpack Compose, it is required to either:
- apply
kotlin-android
plugin in app’s build.gradle file.
plugins {
id 'com.android.application'
id 'kotlin-android'
}
- OR Update Android Gradle Plugin 8.4.0+
Related Google issue_ regarding usage of the Jetpack Compose dependency versions 1.6+_
-
Android Gradle Plugin:
If you are using AGP 8.8.0+, the Android Gradle Plugin will automatically use Build Tools version 35.0.0, regardless of the value you specify.
To ensure full compatibility with our SDK, please upgrade your app’s target and compile SDK version to 35.
iOS
Your application must target iOS 13+ to install the SDK, Update the iOS project xcodeproj to set the deployment target, if needed - typically in iOS/Runner.xcodeproj
. In the application’s Podfile
, include at least this minimum version.
# Podfile
platform :ios, '13.0'
Installation
Add userpilot_flutter
as a dependency in your pubspec.yaml file. You can fetch the latest version from here.
dependencies:
userpilot_flutter: <latest_version>
Then, install the dependency by running flutter pub get
from the terminal.
Notes
- Replace
FlutterActivity
with FlutterFragmentActivity
in your MainActivity
inside example Android app.
- Replace legacy theme
Theme.Black.NoTitleBar
with Theme.AppCompat.NoActionBar
in your style inside example Android app.
Initialization
To use Userpilot, initialize it once in your Application class. This ensures the SDK is ready as soon as your app starts. Update your Application class. Replace <APP_TOKEN>
with your Application Token, which can be fetched from your Environments Page.
import 'package:userpilot_flutter/userpilot_flutter.dart';
UserpilotOptions options = UserpilotOptions();
options.logging = true;
Userpilot.initialize("<APP_TOKEN>", options);
Using the SDK
Once initialized, the SDK provides straightforward APIs for identifying users, tracking events, and screen views.
Identifying Users
This API is used to identify unique users and companies (groups of users) and set their properties. Once identified, all subsequent tracked events and screens will be attributed to that user.
ImportantIt’s crucial to call the Userpilot identify function; without it, Userpilot won’t be able to recognize your users, and mobile content won’t be displayed to them.
Recommended Usage:
- On user authentication (login): Immediately call
identify
when a user signs in to establish their identity for all future events.
- On app launch for authenticated users: If the user has a valid authenticated session, call
identify
at app launch.
- Upon property updates: Whenever user or company properties change.
userpilot.identify(
"<USER_ID>",
{
"name" : "John Doe",
"email" to "user@example.com",
"created_at" to "2019-10-17",
"role" to "Admin"
},
{
"id" to "<COMPANY_ID>",
"name": "Acme Labs",
"created_at": "2019-10-17",
"plan" to "Free"
}
);
Properties Guidelines
- Key
id
is required in company properties, to identify a unique company.
- Userpilot supports String, Numeric, and Date types.
- Make sure you’re sending date values in ISO8601 format.
- If you are planning to use Userpilot’s localization features, make sure you are passing user property
locale_code
with a value that adheres to ISO 639-1 format.
- Userpilot’s reserved properties’ have pre-determined types and improve profiles interface in the dashboard:
- Use key
email
to pass the user’s email.
- Use key
name
to pass the user’s or company’s name.
- Use key
created_at
to pass the user’s or company’s signed up date.
Notes
- Ensure the User ID source is consistent across Web, Android, and iOS.
- While properties are optional, setting them enhances Userpilot’s segmentation capabilities.
Tracking Screens (Required)
Calling screen is crucial for unlocking Userpilot’s core engagement and analytics capabilities. When a user navigates to a particular screen, invoking screen records that view and triggers any eligible in-app experiences. Subsequent events are also attributed to the most recently tracked screen, providing context for richer analytical insights. For these reasons, we strongly recommend tracking all of your app’s screen views.
userpilot.screen("Profile");
Tracking Events
Log any meaningful action the user performs. Events can be button clicks, form submissions, or any custom activity you want to analyze. Optionally, you can pass metadata with the event to provide specific context.
userpilot.track("Added to Cart", {"itemId" : "sku_456", "price" : 29.99})
Logging Out
When a user logs out, call logout()
to clear the current user context. This ensures subsequent events are no longer associated with the previous user.
Anonymous Users
If a user is not authenticated, call anonymous()
to track events without a user ID. This is useful for pre-signup flows or guest user sessions.
Anonymous users count towards your Monthly Active Users usage. Consider your MAU limits before using this API.
Experience
Triggers a specific experience programmatically using it’s ID. This API allows you to manually initiate an experience within your application.
userpilot.triggerExperience("<EXPERIENCE_ID>")
To end current active experience
userpilot.endExperience()
SDK callbacks
Userpilot SDK provides three types of callbacks:
- Navigation Listener
- Analytics Listener
- Experience Listener
Navigation Listener
Triggered when a deep link is invoked from an experience or push notification.
Parameters
url: String
– The custom deep link URL that should be handled by the host (client) app.
Analytics Listener
Triggered when the client app reports an analytics event to the SDK.
Parameters
analytic: String
– The name or type of the analytic event ("Identify"
, "Screen"
, "Event"
).
value: String
– The value associated with the event.
properties: Map<String, Any>
– Additional key-value pairs providing context for the event.
Experience Listener
Provides callbacks related to the lifecycle of experiences and their steps within the SDK.
Callbacks
-
onExperienceStateChanged(id: Int, state: String)
Called when the overall state of an experience changes.
id
: Experience ID (optional)
state
: New state — "Started"
, "Completed"
, "Dismissed"
, "Skipped"
, or "Submitted"
experienceType
: "Flow"
, "Survey"
, or "NPS"
-
onExperienceStepStateChanged(id: Int, state: String, experienceId: Int, step: Int, totalSteps: Int)
Called when the state of a specific step in an experience changes.
id
: Step ID
state
: New step state — "Started"
, "Completed"
, "Dismissed"
, "Skipped"
, or "Submitted"
experienceId
: Associated experience ID
experienceType
: "Flow"
, "Survey"
, or "NPS"
step
: Current step index (optional)
totalSteps
: Total number of steps in the experience (optional)
Note: Both onExperienceStateChanged and onExperienceStepStateChanged events are sent under the key UserpilotExperienceEvent
.
StreamSubscription<UserpilotExperience>? experienceSubscription;
StreamSubscription<UserpilotAnalytic>? analyticsSubscription;
StreamSubscription<UserpilotNavigation>? navigationSubscription;
@override
void initState() {
super.initState();
_initializeUserpilot();
experienceSubscription = Userpilot.onExperienceEvent.listen(
_handleExperienceEvent,
onError: _handleError,
);
analyticsSubscription = Userpilot.onAnalyticEvent.listen(
_handleAnalyticsEvent,
onError: _handleError,
);
navigationSubscription = Userpilot.onNavigationEvent.listen(
_handleNavigationEvent,
onError: _handleError,
);
}
@override
void dispose() {
experienceSubscription?.cancel();
analyticsSubscription?.cancel();
navigationSubscription?.cancel();
super.dispose();
}
void _handleExperienceEvent(UserpilotExperience event) {
print('Experience Event: ${event.state}, ID: ${event.id}');
}
void _handleAnalyticsEvent(UserpilotAnalytic event) {
print('Analytics Event: ${event.analytic}, Value: ${event.value}');
}
void _handleNavigationEvent(UserpilotNavigation event) {
print('Navigation Event URI: ${event.uri}');
}
Push Notifications
Userpilot SDK supports handling push notifications to help you deliver targeted messages and enhance user engagement.
Android Setup:
Prerequisites
It is recommended to configure your Android push settings in the Userpilot Settings Studio before setting up push notifications in your app.
To obtain the required keys and configuration details, please refer to the Android Push Notification Guide.
Setting up
This guide assumes this is the first time code is being added to your project related to setting up push notifications using Google services (Firebase Cloud Messaging). In the case your project is already configured for push, proceed to Step 2.
Step 1. Add Firebase
Follow the steps in the official Google documentation on How to add Firebase to your project.
Step 2. Request Notifications Permission
Starting from Android 13 (API level 33), apps **must explicitly request the **POST_NOTIFICATIONS
permission in order to display push notifications.
- Declare the Permission in the Manifest file, under
example -> android -> app -> manifest
<uses-permission android:name="android.permission.POST_NOTIFICATIONS" />
- Request the Permission at Runtime
For example using : permission_handler: ^11.0.0
void _requestNotificationPermission() {
if (Platform.isAndroid) {
DeviceInfoPlugin().androidInfo.then((androidInfo) {
final sdkInt = androidInfo.version.sdkInt ?? 0;
if (sdkInt >= 33) {
Permission.notification.status.then((status) {
if (status.isDenied || status.isPermanentlyDenied) {
Permission.notification.request().then((result) {
print("Notification permission result: $result");
});
}
});
}
});
}
}
Step 3. Add the Userpilot Firebase Messaging Service
Firebase connects to your app through a <service>
. Go to your Manifest file under example -> android -> app -> manifest
and add:
<service
android:name="com.userpilot.pushNotifications.UserpilotFirebaseMessagingService"
android:exported="false">
<intent-filter>
<action android:name="com.google.firebase.MESSAGING_EVENT" />
</intent-filter>
</service>
If your project has already added a child of FirebaseMessagingService, you can leave it as is, and instead plug in UserpilotFirebaseMessagingService
to your service class.
import com.userpilot.pushNotifications.UserpilotFirebaseMessagingService
import com.google.firebase.messaging.FirebaseMessagingService
import com.google.firebase.messaging.RemoteMessage
class CustomFirebaseMessageService : FirebaseMessagingService() {
override fun onMessageReceived(message: RemoteMessage) {
if (UserpilotFirebaseMessagingService.handleMessage(baseContext, message)) {
// handled as Userpilot message
return
}
// not Userpilot message
super.onMessageReceived(message)
}
override fun onNewToken(token: String) {
// sets new token from the callback
UserpilotFirebaseMessagingService.setToken(token)
super.onNewToken(token)
}
}
Step 4. Deep Linking: Launching Your App When a Notification is Clicked
To ensure your app opens automatically when a Userpilot push notification is clicked, you need to configure an intent-filter
in your app’s **entry **Activity
under example -> android -> app -> manifest
.
This configuration enables deep linking based on a custom scheme defined in your app.
Define the Deep Link Scheme In your userpilot.xml
configuration file, you should have defined a value for userpilot_push_notification
, check Step 5.
Update Manifest file to include the intent-filter as below. Make sure to set host="sdk"
.
<activity
android:name=".MainActivity"
android:exported="true"
android:launchMode="singleTop"
android:taskAffinity=""
android:theme="@style/LaunchTheme"
android:configChanges="orientation|keyboardHidden|keyboard|screenSize|smallestScreenSize|locale|layoutDirection|fontScale|screenLayout|density|uiMode"
android:hardwareAccelerated="true"
android:windowSoftInputMode="adjustResize">
<!-- Specifies an Android theme to apply to this Activity as soon as
the Android process has started. This theme is visible to the user
while the Flutter UI initializes. After that, this theme continues
to determine the Window background behind the Flutter UI. -->
<meta-data
android:name="io.flutter.embedding.android.NormalTheme"
android:resource="@style/NormalTheme"
/>
<intent-filter>
<action android:name="android.intent.action.MAIN"/>
<category android:name="android.intent.category.LAUNCHER"/>
</intent-filter>
<intent-filter>
<data android:scheme="userpilot_push_notification" android:host="sdk"/>
<action android:name="android.intent.action.VIEW" />
<category android:name="android.intent.category.DEFAULT" />
<category android:name="android.intent.category.BROWSABLE" />
</intent-filter>
</activity>
Inside your MainActivity
under example -> android -> app
, pass intent to Userpilot SDK to handle it.
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
handleIntent(intent)
}
override fun onNewIntent(intent: Intent) {
super.onNewIntent(intent)
handleIntent(intent)
}
private fun handleIntent(intent: Intent) {
if (UserpilotFlutterPlugin.handleIntent(intent)) return
}
Step 5. Customizing
The Userpilot SDK allows for some customizations that will change how your messages will be delivered to your end users. These properties are set as <resources>
properties. In order change those properties create a file under res/values
under example -> android -> app
and set it to desired values.
<resources>
<!-- Small icon displayed in the notification bar -->
<drawable name="userpilot_notification_small_icon">@drawable/ic_notification</drawable>
<!-- Accent color applied to notification UI elements -->
<color name="userpilot_notification_color">#6765E8</color>
<!-- Determines if notifications are visible on the lock screen (true = visible) -->
<bool name="userpilot_notification_channel_lock_screen_visibility">true</bool>
<!-- Enables notification lights for the channel -->
<bool name="userpilot_notification_channel_enable_light">true</bool>
<!-- Enables vibration for the notifications -->
<bool name="userpilot_notification_channel_enable_vibration">true</bool>
<!-- Unique ID for the notification channel -->
<string name="userpilot_notification_channel_id">com.userpilot.general.channel</string>
<!-- Human-readable name for the notification channel -->
<string name="userpilot_notification_channel_name">General</string>
<!-- Description shown to the user about this notification channel -->
<string name="userpilot_notification_channel_description">Default channel used for app messages</string>
<!-- Importance level of the notification channel (0 = NONE, 5 = MAX) -->
<integer name="userpilot_notification_channel_importance">3</integer>
<!-- Key used to identify Userpilot push notifications -->
<string name="userpilot_push_notification">userpilot_push_notification</string>
</resources>
iOS Setup
Prerequisites
It is recommended to configure your iOS push settings in the Userpilot Settings Studio before setting up push notifications in your app.
To obtain the required keys and configuration details, please refer to the iOS Push Notification Guide.
Enabling Push Notification Capabilities
In Xcode, navigate to the Signing & Capabilities section of your main app target and add the Push Notifications capability.
Configuring Push Notifications
The Userpilot iOS SDK supports receiving push notification so you can reach your users whenever the moment is right.
There are two options for configuring push notification: automatic or manual.
Automatic configuration is the quickest and simplest way to configure push notifications and is recommended for most customers.
Automatic App Configuration
Automatic configuration takes advantage of swizzling to automatically provide the necessary implementations of the required UIApplicationDelegate
and UNUserNotificationCenterDelegate
methods.
To enable automatic configuration, call Userpilot.enableAutomaticPushConfig()
from UIApplicationDelegate.application(_:didFinishLaunchingWithOptions:)
inside example -> ios -> AppDelegate.swift
.
func application(
_ application: UIApplication, didFinishLaunchingWithOptions
launchOptions: [UIApplication.LaunchOptionsKey: Any]?
) -> Bool {
// Automatically configure for push notifications
Userpilot.enableAutomaticPushConfig()
// Override point for customization after application launch.
return true
}
Automatic configuration seamlessly integrates with your app’s existing push notification handling. It processes only Userpilot notifications, while ensuring that all other notifications continue to be handled by your app’s original logic.
Manually Configuring Push Notifications
Step 1. Enable push capabilities
Step 2. Register for push notifications
Step 3. Set push token for Userpilot
Step 4. Enable push response handling
Step 5. Configure foreground handling
Full source code:
// AppDelegate+PushNotification.swift
import Foundation
import UserNotifications
import userpilot_flutter
extension AppDelegate {
/// Call from `UIApplicationDelegate.application(_:didFinishLaunchingWithOptions:)`
func setupPush(application: UIApplication) {
requestPushNotificationPermission()
// 1: Register to get a device token
application.registerForRemoteNotifications()
UNUserNotificationCenter.current().delegate = self
}
// MARK: - Push Notification Permission Request, In case you didn't request it from your Flutter app.
private func requestPushNotificationPermission() {
let options: UNAuthorizationOptions = [.alert, .sound, .badge]
// Check if the app has already been authorized
UNUserNotificationCenter.current().getNotificationSettings { (settings) in
if settings.authorizationStatus == .authorized {
// App is already authorized for push notifications
// Register for remote notifications again to get the device token
DispatchQueue.main.async {
UIApplication.shared.registerForRemoteNotifications()
}
} else {
// If not authorized, request permission
UNUserNotificationCenter.current().requestAuthorization(options: options) { (granted, error) in
if granted {
DispatchQueue.main.async {
UIApplication.shared.registerForRemoteNotifications()
}
} else {
if let errorDescription = error?.localizedDescription {
print("Permission denied or failed to request: \(errorDescription)")
} else {
print("Permission denied or failed to request: Unknown error")
}
}
}
}
}
}
// 2: Pass device token to Userpilot
override func application(_ application: UIApplication, didRegisterForRemoteNotificationsWithDeviceToken deviceToken: Data) {
SwiftUserpilotFlutterPlugin.setPushToken(deviceToken)
}
// 3: Pass the user's response to a delivered notification to Userpilot
override func userNotificationCenter(
_ center: UNUserNotificationCenter,
didReceive response: UNNotificationResponse,
withCompletionHandler completionHandler: @escaping () -> Void
) {
if SwiftUserpilotFlutterPlugin.didReceiveNotification(response: response, completionHandler: completionHandler) {
return
}
super.userNotificationCenter(center, didReceive: response, withCompletionHandler: completionHandler)
}
// 4: Configure handling for notifications that arrive while the app is in the foreground
override func userNotificationCenter(
_ center: UNUserNotificationCenter,
willPresent notification: UNNotification,
withCompletionHandler completionHandler: @escaping (UNNotificationPresentationOptions) -> Void
) {
if #available(iOS 14.0, *) {
completionHandler([.banner, .list])
} else {
completionHandler(.alert)
}
}
}