API Reference

Most core methods return a Promise. Await them when you need to sequence work after the native call completes.

Core SDK

`Zixflow.initialize(config: ZixflowConfig): Promise<void>`

When to use: Once at app startup (root useEffect). On Android this also registers the push module; on iOS you still initialize MessagingPush in AppDelegate.

await Zixflow.initialize({
  apiKey: 'YOUR_API_KEY',
});

`Zixflow.identify(params: IdentifyParams): Promise<void>`

When to use: After login or when you know the user. Provide userId, traits, or both. Required before targeted push.

await Zixflow.identify({
  userId: 'user-123',
  traits: { email: 'user@example.com' },
});

`Zixflow.clearIdentify(): Promise<void>`

When to use: On logout. Pair with deleteDeviceToken() so the device stops receiving that user’s pushes.

await Zixflow.clearIdentify();

`Zixflow.track(name: string, properties?: Record<string, any>): Promise<void>`

When to use: Custom product analytics events (button clicks, purchases, etc.).

await Zixflow.track('button_clicked', { button_name: 'signup' });

`Zixflow.screen(title: string, properties?: Record<string, any>): Promise<void>`

When to use: Screen views (manual or React Navigation listener).

await Zixflow.screen('HomeScreen');

`Zixflow.setProfileAttributes(attributes: Record<string, any>): Promise<void>`

When to use: Update traits on the identified user without a full re-identify.

await Zixflow.setProfileAttributes({ plan: 'premium' });

`Zixflow.setDeviceAttributes(attributes: Record<string, any>): Promise<void>`

When to use: Attach attributes to the current device (app version, theme, etc.).

await Zixflow.setDeviceAttributes({ app_version: '2.0.0' });

`Zixflow.registerDeviceToken(token: string): Promise<void>`

When to use: Manually register an FCM/APNs token (usually automatic after native push setup; use on token refresh in custom FCM flows).

await Zixflow.registerDeviceToken(token);

`Zixflow.deleteDeviceToken(): Promise<void>`

When to use: Logout or when the user disables notifications.

await Zixflow.deleteDeviceToken();

`Zixflow.trackMetric(params): Promise<void>`

When to use: Manual push metrics when you are not on the default auto-tracking path, or to record Converted after a goal.

import { MetricEvent } from 'zixflow-reactnative';

await Zixflow.trackMetric({
  deliveryID: '626533406292836846',
  deviceToken: token,
  event: MetricEvent.Delivered, // or MetricEvent.Opened / MetricEvent.Converted
});

Push Messaging

`Zixflow.pushMessaging.showPromptForPushNotifications(options?): Promise<ZixflowPushPermissionStatus>`

When to use: Request OS notification permission (iOS prompt; Android 13+ POST_NOTIFICATIONS).

const status = await Zixflow.pushMessaging.showPromptForPushNotifications({
  ios: { sound: true, badge: true },
});

`Zixflow.pushMessaging.getPushPermissionStatus(): Promise<ZixflowPushPermissionStatus>`

When to use: Check current permission without prompting.

const status = await Zixflow.pushMessaging.getPushPermissionStatus();

`Zixflow.pushMessaging.getRegisteredDeviceToken(): Promise<string>`

When to use: Read the token the SDK has registered (debug, support, or re-register flows).

const token = await Zixflow.pushMessaging.getRegisteredDeviceToken();

`Zixflow.pushMessaging.onMessageReceived(message, handleNotificationTrigger?): Promise<boolean>`

When to use: Android — process an FCM message your app received in JS (foreground). Displays and/or tracks. On iOS this resolves to true without additional work.

await Zixflow.pushMessaging.onMessageReceived(remoteMessage, true);

`Zixflow.pushMessaging.onBackgroundMessageReceived(message): Promise<boolean>`

When to use: Android background FCM helper around onMessageReceived (avoids double-display when FCM already showed a notification).

await Zixflow.pushMessaging.onBackgroundMessageReceived(remoteMessage);

`Zixflow.pushMessaging.trackNotificationReceived(payload): void`

When to use: iOS custom pipelines — mark delivery. No-op on Android (auto via FCM module).

`Zixflow.pushMessaging.trackNotificationResponseReceived(payload): void`

When to use: iOS custom pipelines — mark open/tap. No-op on Android.

Location

Enable the native location module first (Location Tracking).

`Zixflow.location.setLastKnownLocation(latitude: number, longitude: number): void`

When to use: Supply coordinates from your own location provider (MANUAL mode).

Zixflow.location.setLastKnownLocation(37.7749, -122.4194);

`Zixflow.location.requestLocationUpdate(): void`

When to use: Ask the SDK to refresh location when the module is enabled.

Zixflow.location.requestLocationUpdate();

Types

`ZixflowConfig`

type ZixflowConfig = {
  apiKey: string;
  logLevel?: ZixflowLogLevel;
  apiHost?: string;
  cdnHost?: string;
  flushAt?: number;
  flushInterval?: number;
  screenViewUse?: ScreenView;
  trackApplicationLifecycleEvents?: boolean;
  autoTrackDeviceAttributes?: boolean;
  push?: {
    android?: {
      pushClickBehavior?: PushClickBehaviorAndroid;
    };
  };
  location?: {
    trackingMode?: ZixflowLocationTrackingMode;
  };
};

`ZixflowLogLevel`

enum ZixflowLogLevel {
  None = 'none',
  Error = 'error',
  Info = 'info',
  Debug = 'debug',
}

`ScreenView`

enum ScreenView {
  All = 'all',
}

`ZixflowLocationTrackingMode`

enum ZixflowLocationTrackingMode {
  Off = 'OFF',
  Manual = 'MANUAL',
  OnAppStart = 'ON_APP_START',
}

`MetricEvent`

enum MetricEvent {
  Delivered = 'delivered',
  Opened = 'opened',
  Converted = 'converted',
}

Use Converted when the user completes a post-open goal you want attributed to the push campaign.

`PushClickBehaviorAndroid`

enum PushClickBehaviorAndroid {
  ResetTaskStack = 'RESET_TASK_STACK',
  ActivityPreventRestart = 'ACTIVITY_PREVENT_RESTART',
  ActivityNoFlags = 'ACTIVITY_NO_FLAGS',
}

`ZixflowPushPermissionStatus`

enum ZixflowPushPermissionStatus {
  Granted = 'GRANTED',
  Denied = 'DENIED',
  NotDetermined = 'NOTDETERMINED',
}

Getting Started

Features

Advanced

Reference

Core SDK

`Zixflow.initialize(config: ZixflowConfig): Promise<void>`

`Zixflow.identify(params: IdentifyParams): Promise<void>`

`Zixflow.clearIdentify(): Promise<void>`

`Zixflow.track(name: string, properties?: Record<string, any>): Promise<void>`

`Zixflow.screen(title: string, properties?: Record<string, any>): Promise<void>`

`Zixflow.setProfileAttributes(attributes: Record<string, any>): Promise<void>`

`Zixflow.setDeviceAttributes(attributes: Record<string, any>): Promise<void>`

`Zixflow.registerDeviceToken(token: string): Promise<void>`

`Zixflow.deleteDeviceToken(): Promise<void>`

`Zixflow.trackMetric(params): Promise<void>`

Push Messaging

`Zixflow.pushMessaging.showPromptForPushNotifications(options?): Promise<ZixflowPushPermissionStatus>`

`Zixflow.pushMessaging.getPushPermissionStatus(): Promise<ZixflowPushPermissionStatus>`

`Zixflow.pushMessaging.getRegisteredDeviceToken(): Promise<string>`

`Zixflow.pushMessaging.onMessageReceived(message, handleNotificationTrigger?): Promise<boolean>`

`Zixflow.pushMessaging.onBackgroundMessageReceived(message): Promise<boolean>`

`Zixflow.pushMessaging.trackNotificationReceived(payload): void`

`Zixflow.pushMessaging.trackNotificationResponseReceived(payload): void`

Location

`Zixflow.location.setLastKnownLocation(latitude: number, longitude: number): void`

`Zixflow.location.requestLocationUpdate(): void`

Types

`ZixflowConfig`

`ZixflowLogLevel`

`ScreenView`

`ZixflowLocationTrackingMode`

`MetricEvent`

`PushClickBehaviorAndroid`

`ZixflowPushPermissionStatus`

Guides

​Core SDK

​Zixflow.initialize(config: ZixflowConfig): Promise<void>

​Zixflow.identify(params: IdentifyParams): Promise<void>

​Zixflow.clearIdentify(): Promise<void>

​Zixflow.track(name: string, properties?: Record<string, any>): Promise<void>

​Zixflow.screen(title: string, properties?: Record<string, any>): Promise<void>

​Zixflow.setProfileAttributes(attributes: Record<string, any>): Promise<void>

​Zixflow.setDeviceAttributes(attributes: Record<string, any>): Promise<void>

​Zixflow.registerDeviceToken(token: string): Promise<void>

​Zixflow.deleteDeviceToken(): Promise<void>

​Zixflow.trackMetric(params): Promise<void>

​Push Messaging

​Zixflow.pushMessaging.showPromptForPushNotifications(options?): Promise<ZixflowPushPermissionStatus>

​Zixflow.pushMessaging.getPushPermissionStatus(): Promise<ZixflowPushPermissionStatus>

​Zixflow.pushMessaging.getRegisteredDeviceToken(): Promise<string>

​Zixflow.pushMessaging.onMessageReceived(message, handleNotificationTrigger?): Promise<boolean>

​Zixflow.pushMessaging.onBackgroundMessageReceived(message): Promise<boolean>

​Zixflow.pushMessaging.trackNotificationReceived(payload): void

​Zixflow.pushMessaging.trackNotificationResponseReceived(payload): void

​Location

​Zixflow.location.setLastKnownLocation(latitude: number, longitude: number): void

​Zixflow.location.requestLocationUpdate(): void

​Types

​ZixflowConfig

​ZixflowLogLevel

​ScreenView

​ZixflowLocationTrackingMode

​MetricEvent

​PushClickBehaviorAndroid

​ZixflowPushPermissionStatus

​Guides

Core SDK

`Zixflow.initialize(config: ZixflowConfig): Promise<void>`

`Zixflow.identify(params: IdentifyParams): Promise<void>`

`Zixflow.clearIdentify(): Promise<void>`

`Zixflow.track(name: string, properties?: Record<string, any>): Promise<void>`

`Zixflow.screen(title: string, properties?: Record<string, any>): Promise<void>`

`Zixflow.setProfileAttributes(attributes: Record<string, any>): Promise<void>`

`Zixflow.setDeviceAttributes(attributes: Record<string, any>): Promise<void>`

`Zixflow.registerDeviceToken(token: string): Promise<void>`

`Zixflow.deleteDeviceToken(): Promise<void>`

`Zixflow.trackMetric(params): Promise<void>`

Push Messaging

`Zixflow.pushMessaging.showPromptForPushNotifications(options?): Promise<ZixflowPushPermissionStatus>`

`Zixflow.pushMessaging.getPushPermissionStatus(): Promise<ZixflowPushPermissionStatus>`

`Zixflow.pushMessaging.getRegisteredDeviceToken(): Promise<string>`

`Zixflow.pushMessaging.onMessageReceived(message, handleNotificationTrigger?): Promise<boolean>`

`Zixflow.pushMessaging.onBackgroundMessageReceived(message): Promise<boolean>`

`Zixflow.pushMessaging.trackNotificationReceived(payload): void`

`Zixflow.pushMessaging.trackNotificationResponseReceived(payload): void`

Location

`Zixflow.location.setLastKnownLocation(latitude: number, longitude: number): void`

`Zixflow.location.requestLocationUpdate(): void`

Types

`ZixflowConfig`

`ZixflowLogLevel`

`ScreenView`

`ZixflowLocationTrackingMode`

`MetricEvent`

`PushClickBehaviorAndroid`

`ZixflowPushPermissionStatus`

Guides