Flutter Plugin

​

Getting Started

​

Android Requirements

android {
    compileSdk 35

    defaultConfig {
        minSdk 21
    }
}

1. Apply the kotlin-android plugin in your app’s build.gradle file.

plugins {  
    id 'com.android.application' 
    id 'kotlin-android' 
}

2. Or update to Android Gradle Plugin 8.4.0+.

Related Google issue regarding usage of Jetpack Compose dependency versions 1.6+.

​

iOS Requirements

# Podfile
platform :ios, '13.0'

​

Installing the Library

dependencies:
  userpilot_flutter: <latest_version>

• The Userpilot Flutter plugin now supports Swift Package Manager (SPM) for iOS integration.
• For detailed setup instructions, refer to the Swift Package Manager guide for Flutter app developers.

• Replace FlutterActivity with FlutterFragmentActivity in your MainActivity.
• Replace legacy theme Theme.Black.NoTitleBar with Theme.AppCompat.NoActionBar in your style.

​

Initialize the SDK

import 'package:userpilot_flutter/userpilot_flutter.dart';

UserpilotOptions options = UserpilotOptions();
options.logging = true;
 
Userpilot.initialize("<APP_TOKEN>", options);

​

Identify Users (Required)

• 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": "user@example.com", 
        "created_at": "2019-10-17", 
        "role": "Admin"
    },   
    {
        "id": "<COMPANY_ID>",
        "name": "Acme Labs", 
        "created_at": "2019-10-17", 
        "plan": "Free"
    }
);

• The id key is required in company properties to identify a unique company.
• Userpilot supports String, Numeric, and Date types.
• Send date values in ISO8601 format.
• If you plan to use Userpilot’s localization features, pass the user property locale_code with a value that adheres to ISO 639-1 format.
• Userpilot’s reserved properties have pre-determined types and improve the 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 signup date.

​

Track Screens (Required)

userpilot.screen("Profile");

​

Send Events

userpilot.track("Added to Cart", {"itemId": "sku_456", "price": 29.99})

​

Logout

userpilot.logout()

​

Anonymous Users

userpilot.anonymous()

​

Experiences

userpilot.triggerExperience("<EXPERIENCE_ID>")

userpilot.endExperience()

​

Configuration (Optional)