Cordova Plugin for the native Userpilot SDKs on Android and iOS
npm install @userpilot/cordova
Userpilot Cordova 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 plugin's public APIs.
- Userpilot Cordova Plugin
- 🚀 Getting Started
- Prerequisites
- Installation
- Initializing
- Identifying Users
- Tracking Screens
- Tracking Events
- Trigger Experience
- SDK Callbacks
- Push Notifications
- 📝 Documentation
- 🎬 Examples
- 📄 License
Cordova - your application should use Cordova version 10+ with cordova-cli installed globally.
Android - your application's config.xml must have a android-compileSdkVersion of 35+ and android-minSdkVersion of 24+. Your project should use the Android Gradle Plugin (AGP) version 8.1 or above.
``xml`
iOS - your application must target iOS 13+ to install the SDK, Update the iOS project xcodeproj to set the deployment target. Update your config.xml to set the deployment target.
`xml`
Add the Userpilot Cordova Plugin to your application.
1. In your app's root directory, install the Userpilot Cordova Plugin
`sh`
cordova plugin add @userpilot/cordova
3. Prepare your platforms:
`sh`
cordova prepare
To use Userpilot, initialize it once when your device is ready. This ensures the SDK is ready as soon as your app starts. Replace with your Application Token, which can be fetched from your Environments Page.
##### API:
`js`
setup(token, options, onSuccess, onError)
##### Basic Example:
`js`
document.addEventListener('deviceready', function() {
window.userpilot.setup('
function(success) {
console.log('Userpilot initialized successfully');
},
function(error) {
console.error('Failed to initialize Userpilot:', error);
}
);
}, false);
##### Advanced Example with Options:
`js`
document.addEventListener('deviceready', function() {
const options = {
logging: true, // Enable/disable SDK logging
useInAppBrowser: true, // Enable/disable in-app browser for links - Works for Android
};
window.userpilot.setup('
function(success) {
console.log('Userpilot initialized successfully');
},
function(error) {
console.error('Failed to initialize Userpilot:', error);
}
);
}, false);
##### SDK Configurations
| Parameter | Type | Description |
| ----------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------ |
| logging | Boolean | Enable or Disable logs for SDK
Default: false |
| disableRequestPushNotificationsPermission | Boolean | Disable request push notifications permission by SDK.
Default: false |
| useInAppBrowser | Boolean | configuration to indicate when to open the URL inside CustomTabsIntent or not.
Default: false |
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.
Recommended Usage:
- On user authentication (login): Immediately call identify when a user signs in to establish their identity for all future events.identify
- On app launch for authenticated users: If the user has a valid authenticated session, call at app launch.
- Upon property updates: Whenever user or company properties change.
##### API:
`js`
identify(userID, properties, company, onSuccess, onError)
##### Example:
`js`
window.userpilot.identify(
'
{
'name': 'John Doe',
'email': 'user@example.com',
'created_at': '2019-10-17',
'role': 'Admin'
},
{
'id': 'company123',
'name': 'Acme Labs',
'created_at': '2019-10-17',
'plan': 'Free'
},
function(success) {
console.log('User identified successfully');
},
function(error) {
console.error('Failed to identify user:', error);
}
);
Properties Guidelines
- Key id is required in company properties, to identify a unique company.locale_code
- 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 with a value that adheres to ISO 639-1 format.email
- Userpilot's reserved properties have pre-determined types and improve profiles interface in the dashboard:
- Use key to pass the user's email.name
- Use key to pass the user's or company's name.created_at
- Use key to pass the user's or company's signed up date.
Notes
- Make sure your User ID source is consistent across all of your platform installations (Web, Android, and iOS).
- While properties are optional, they are essential in Userpilot's segmentation capabilities. We encourage you to set the properties with the people who are responsible for Userpilot integration.
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.
##### API:
`js`
screen(screenName, onSuccess, onError)
##### Example:
`js`
window.userpilot.screen('Profile',
function(success) {
console.log('Screen tracked successfully');
},
function(error) {
console.error('Failed to track screen:', error);
}
);
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.
##### API:
`js`
track(name, properties, onSuccess, onError)
##### Example:
`js`
window.userpilot.track('Added to Cart',
{
itemId: 'sku_456',
price: 29.99
},
function(success) {
console.log('Event tracked successfully');
},
function(error) {
console.error('Failed to track event:', error);
}
);
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.
##### API:
`js`
logout(onSuccess, onError)
##### Example:
`js`
window.userpilot.logout(
function(success) {
console.log('User logged out successfully');
},
function(error) {
console.error('Failed to logout user:', error);
}
);
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.
##### API:
`js`
anonymous(onSuccess, onError)
##### Example:
`js`
window.userpilot.anonymous(
function(success) {
console.log('Anonymous user set successfully');
},
function(error) {
console.error('Failed to set anonymous user:', error);
}
);
Notes
- Anonymous users are counted towards your Monthly Active Users usage. You should take your account's MAU limit into consideration before applying this API.
Triggers a specific experience programmatically using its ID. This API allows you to manually initiate an experience within your application.
##### API:
`js`
triggerExperience(experienceId, onSuccess, onError)
##### Example:
`js`
window.userpilot.triggerExperience('
function(success) {
console.log('Experience triggered successfully');
},
function(error) {
console.error('Failed to trigger experience:', error);
}
);
Ends the current active experience programmatically.
##### API:
`js`
endExperience(onSuccess, onError)
##### Example:
`js`
window.userpilot.endExperience(
function(success) {
console.log('Experience ended successfully');
},
function(error) {
console.error('Failed to end experience:', error);
}
);
#### SDK callbacks
Userpilot SDK provides three types of callbacks:
- Navigation Listener
- Analytics Listener
- Experience Listener
Navigation Listener is called when a deep link is triggered from an experience or notification. It holds the custom deep link URL to be handled by the client app.
Params:
`js`
url: string
Analytics Listener is called when an event is triggered by the client app.
Params:
`js`
analytic: string
value: string
properties: Map
Analytics Listener
Called when an analytics event is triggered by the Userpilot SDK.
Use this to mirror or log SDK-level events into your analytics system.
Params:
`js
analytic: "Identify" | "Screen" | "Event"
value: String — Event value, if any.
properties: Map
`
Experience Listener
Called when an experience or its step changes state. Includes two callback types:
onExperienceStateChanged
Triggered when the overall state of an experience changes.
`js
experienceId?: Int — Unique ID of the experience (optional)
experienceType: "Flow" | "Survey" | "NPS"
experienceState: "Started" | "Completed" | "Dismissed" | "Skipped" | "Submitted"
`
onExperienceStepStateChanged
Triggered when the state of a specific step within an experience changes.
`js
stepId: Int — Unique identifier of the step
experienceId: Int — ID of the parent experience
experienceType: "Flow" | "Survey" | "NPS"
stepState: "Started" | "Completed" | "Dismissed" | "Skipped" | "Submitted"
step?: Int — Step index (optional)
totalSteps?: Int — Total number of steps in the experience (optional)
`
Both callbacks are sent under the same event name: UserpilotExperienceEvent
`js
// Register for callbacks
window.userpilot.registerCallbacks(
function(event) {
console.log('Callback received:', event);
},
function(error) {
console.error('Failed to register callbacks:', error);
}
);
// Set up individual event listeners
window.userpilot.onUserpilotNavigationEvent(function(data) {
console.log('Navigation Event:', data);
// Handle deep link navigation
if (data.url) {
handleDeepLink(data.url);
}
});
window.userpilot.onUserpilotAnalyticsEvent(function(data) {
console.log('Analytics Event:', data);
});
window.userpilot.onUserpilotExperienceEvent(function(data) {
console.log('Experience Event:', data);
});
`
Userpilot SDK supports handling push notifications to help you deliver targeted messages and enhance user engagement. For setup instructions, and integration details, please refer to the Push Notification Guide.
Full documentation is available at Userpilot
The UserpilotSample` repository contains a full example Cordova app providing references for correct installation and usage of the Userpilot Plugin APIs.
This project is licensed under the MIT License. See LICENSE for more information.