React Native Module

Prerequisites

React Native

Android

android {
    compileSdk 35
    defaultConfig {
        minSdk 21
    }
}

iOS

# Podfile
platform :ios, '13.0'

Installation

1. In your app’s root directory, install the Userpilot React Native Module. You can fetch the latest version from here. Release notes are available here.

npm install @userpilot/react-native

1. Under your application’s ios folder, run

pod install

Initialization

import * as Userpilot from '@userpilot/react-native'

await Userpilot.setup('<APP_TOKEN>', { logging: true })

Using the SDK

Identifying Users

• 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.

// API
identify(userID: string, properties?: Object, company?: Object): void;

// Example
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'
  }
)

• 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.

Tracking Screens (Required)

// API
screen(title: string): void;

// Example
userpilot.screen('Profile');

Tracking Events

// API
track(name: string, properties?: Object): void;

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

Logging Out

userpilot.logout()

Anonymous Users

userpilot.anonymous()

Experience

// API
triggerExperience(experienceID: string): void;

// Example
userpilot.triggerExperience('<EXPERIENCE_ID>')

userpilot.endExperience()

Configurations (Optional)

Privacy Manifest