Core Features

User Identification

Use Zixflow.identify so events, devices, and messages attach to a person. Call it after login or whenever you know who is using the app — before sending targeted push.

import { Zixflow } from 'zixflow-reactnative';

await Zixflow.identify({
  userId: 'user-123',
  traits: {
    email: 'user@example.com',
    firstName: 'Alex',
    lastName: 'Rivera',
    plan: 'premium',
  },
});

Parameter	Required	Description
`userId`	Recommended	Stable person ID (your internal ID or email).
`traits`	Optional	Profile attributes to create or update.

Only one person is current at a time. Identifying someone else switches the active profile; later track / screen calls associate with the new person. Identifying also ties the current device token to that profile when push is set up.

Event Tracking

Events describe actions people take in your app. Use them to build segments, trigger campaigns, and measure product usage.

import { Zixflow } from 'zixflow-reactnative';

await Zixflow.track('product_viewed', {
  product_id: '12345',
  product_name: 'Premium Plan',
  category: 'subscription',
  price: 29.99,
});

Name-only events are valid too:

await Zixflow.track('button_clicked');

Field	Description
Event name	Stable string your team recognizes in the dashboard.
Properties	Optional key/value context referenced in campaign logic.

Avoid invalid JSON values such as NaN or Infinity in properties — those fields may be dropped. Examples worth tracking: product views, add-to-cart, checkout, feature usage, content reads, form submissions.

Screen Tracking

Screen events record which views people visit. They update activity history and can drive segments and campaigns.

import { Zixflow } from 'zixflow-reactnative';

await Zixflow.screen('HomeScreen');

await Zixflow.screen('ProductDetailScreen', {
  product_id: '12345',
  category: 'electronics',
});

import { NavigationContainer, NavigationContainerRef } from '@react-navigation/native';
import { Zixflow } from 'zixflow-reactnative';
import React, { useRef } from 'react';

export default function App() {
  const navigationRef = useRef<NavigationContainerRef>(null);
  const routeNameRef = useRef<string>();

  return (
    <NavigationContainer
      ref={navigationRef}
      onReady={() => {
        routeNameRef.current = navigationRef.current?.getCurrentRoute()?.name;
      }}
      onStateChange={async () => {
        const previousRouteName = routeNameRef.current;
        const currentRouteName = navigationRef.current?.getCurrentRoute()?.name;

        if (previousRouteName !== currentRouteName && currentRouteName) {
          await Zixflow.screen(currentRouteName);
        }

        routeNameRef.current = currentRouteName;
      }}
    >
      {/* navigators */}
    </NavigationContainer>
  );
}

Lifecycle Events

When trackApplicationLifecycleEvents is enabled (default true), the SDK sends track events for common app lifecycle moments. You will see them as normal track events in Zixflow with lifecycle-specific properties (for example app version / build on install).

Event name	Typical meaning
`Application Installed`	First open after install
`Application Updated`	Open after an app version change
`Application Opened`	Cold start / launch
`Application Foregrounded`	Returned to the foreground
`Application Backgrounded`	Left the foreground

Exact timing can differ slightly between iOS and Android; treat these as product analytics events you can segment and trigger on.

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

const config: ZixflowConfig = {
  apiKey: 'YOUR_API_KEY',
  trackApplicationLifecycleEvents: true, // set false to opt out
};

await Zixflow.initialize(config);

For crashes or other moments the SDK cannot observe, send your own track using the same naming style:

await Zixflow.track('Application Crashed', {
  screen: 'Checkout',
});

Anonymous Activity

Before Zixflow.identify, SDK calls (tracks, screens, lifecycle events) still run. They are associated with an anonymous device/session identity rather than a known person profile.

You generally will not find an “anonymous person” to message in the workspace the way you message identified profiles.
Anonymous activity alone does not enable personalized push for a known user.
When you identify, Zixflow reconciles prior anonymous activity with that person so earlier events can contribute to segments and campaign eligibility.

Typical flow:

User opens the app → lifecycle / screen / track fire anonymously.
User logs in → Zixflow.identify({ userId, traits }).
History merges; later campaigns can use that combined activity.

Identify as soon as you know the user if you need messaging and attribution.

Profile Attributes

After identify, update traits without repeating the full identify payload:

await Zixflow.setProfileAttributes({
  plan: 'premium',
  subscription_status: 'active',
  preferences: {
    newsletter: true,
    notifications: true,
  },
});

Only the attributes you pass are upserted; other existing traits remain.

Device Attributes

With autoTrackDeviceAttributes: true (default), the SDK collects device details automatically. Add your own:

await Zixflow.setDeviceAttributes({
  app_version: '2.1.0',
  build_number: '421',
  theme: 'dark',
});

Prefer profile attributes for values that should outlive a single install/token.

Device Token

Usually the push module handles tokens. To attach a token yourself:

await Zixflow.registerDeviceToken(token);

User Logout

await Zixflow.deleteDeviceToken();
await Zixflow.clearIdentify();

clearIdentify also clears cached location used for enrichment so the next session does not inherit the previous person’s coordinates (Location Tracking).

Getting Started

Features

Advanced

Reference

User Identification

Event Tracking

Screen Tracking

React Navigation

Lifecycle Events

Anonymous Activity

Profile Attributes

Device Attributes

Device Token

User Logout

​User Identification

​Event Tracking

​Screen Tracking

​React Navigation

​Lifecycle Events

​Anonymous Activity

​Profile Attributes

​Device Attributes

​Device Token

​User Logout

User Identification

Event Tracking

Screen Tracking

React Navigation

Lifecycle Events

Anonymous Activity

Profile Attributes

Device Attributes

Device Token

User Logout