Installation

The Zixflow React Native SDK is available on npm. You can browse the package here: npm - zixflow-reactnative

npm Installation

npm install zixflow-reactnative@^1.1.3

Yarn Installation

yarn add zixflow-reactnative@^1.1.3

Artifact	Name	Version
JavaScript / TypeScript	`zixflow-reactnative`	1.1.3

Import the public API from 'zixflow-reactnative' (Zixflow, ZixflowConfig, enums, and modules).

API key

The SDK needs a single write credential: your API key. Pass it as apiKey on ZixflowConfig when you call Zixflow.initialize.

Open the Zixflow dashboard.
Go to your workspace Settings (or your mobile / React Native integration connection).
Copy the API key for that integration.

import { Zixflow, ZixflowConfig, ZixflowLogLevel } from 'zixflow-reactnative';

const config: ZixflowConfig = {
  apiKey: 'YOUR_API_KEY',
  logLevel: ZixflowLogLevel.Debug,
};

await Zixflow.initialize(config);

There is no separate public siteId field — pass your workspace API key as apiKey on ZixflowConfig. Rich push on iOS initializes the push module inside the Notification Service Extension with the same API key (see Push Notifications). Securing credentials: Prefer environment variables or CI secrets — avoid committing production keys. Keep ZixflowLogLevel.Debug for development only.

iOS CocoaPods subspecs

Add pods under your app target (and NSE target when using rich push). Paths assume the package lives in node_modules.

Subspec	Purpose
`zixflow-reactnative/apn`	Host app — APNs push
`zixflow-reactnative/fcm`	Host app — FCM push on iOS
`zixflow-reactnative/location`	Optional location module
`zixflow-reactnative-richpush/apn`	Notification Service Extension — APNs rich push
`zixflow-reactnative-richpush/fcm`	Notification Service Extension — FCM rich push

Pick either apn or fcm for the host app (and the matching richpush subspec). Details: Platform-Specific Setup, Push Notifications. On Android, React Native auto-linking pulls native modules. FCM needs the Google Services plugin and google-services.json — see Platform-Specific Setup.

Configuration options (`ZixflowConfig`)

Set options before Zixflow.initialize. You cannot change them after init.

import {
  Zixflow,
  ZixflowConfig,
  ZixflowLogLevel,
  ScreenView,
  PushClickBehaviorAndroid,
  ZixflowLocationTrackingMode,
} from 'zixflow-reactnative';

const config: ZixflowConfig = {
  apiKey: 'YOUR_API_KEY',
  logLevel: ZixflowLogLevel.Debug,
  autoTrackDeviceAttributes: true,
  trackApplicationLifecycleEvents: true,
  screenViewUse: ScreenView.All,
  push: {
    android: {
      pushClickBehavior: PushClickBehaviorAndroid.ActivityPreventRestart,
    },
  },
  location: {
    trackingMode: ZixflowLocationTrackingMode.Manual,
  },
};

await Zixflow.initialize(config);

Option	Type	Default	Description
`apiKey`	string	—	Required. Workspace write key.
`logLevel`	`ZixflowLogLevel`	`error`	`None`, `Error`, `Info`, `Debug`.
`autoTrackDeviceAttributes`	boolean	`true`	Device OS, model, app version, and similar.
`trackApplicationLifecycleEvents`	boolean	`true`	App install / open / background lifecycle tracks.
`screenViewUse`	`ScreenView`	`All`	Controls how screen events are sent to Zixflow.
`apiHost` / `cdnHost`	string	—	First-party proxy hosts (set both when proxying).
`flushAt` / `flushInterval`	number	SDK defaults	Batching controls.
`push.android.pushClickBehavior`	`PushClickBehaviorAndroid`	`ActivityPreventRestart`	Android activity behavior on notification tap.
`location.trackingMode`	`ZixflowLocationTrackingMode`	—	Enable location module mode.

More detail: Advanced Configuration, API Reference. After installation, follow Platform-Specific Setup, then Quick Start.

Getting Started

Features

Advanced

Reference

npm Installation

Yarn Installation

API key

iOS CocoaPods subspecs

Configuration options (`ZixflowConfig`)

​npm Installation

​Yarn Installation

​API key

​iOS CocoaPods subspecs

​Configuration options (ZixflowConfig)

npm Installation

Yarn Installation

API key

iOS CocoaPods subspecs

Configuration options (`ZixflowConfig`)