Platform-Specific Setup

iOS Setup

CocoaPods Integration

The Zixflow React Native SDK integrates with the native iOS SDK via CocoaPods. If you’re using React Native 0.60 or higher, core dependencies are auto-linked.

Navigate to the iOS directory:

cd ios

Install CocoaPods dependencies:

pod install

Open the workspace in Xcode:

open YourApp.xcworkspace

For most React Native apps, CocoaPods auto-linking is enough for CDP. Push requires an explicit Podfile subspec (next section).

Push Notification Setup (APNs)

Add the APNs subspec in your ios/Podfile (inside your app target), then run pod install:

pod 'zixflow-reactnative/apn', :path => '../node_modules/zixflow-reactnative'

For Firebase on iOS instead, use zixflow-reactnative/fcm and use_frameworks! :linkage => :static — see Push Notifications.

Enable Push Notifications in Xcode:
- Select your app target → Signing & Capabilities
- Click + Capability → Push Notifications
Enable Background Modes:
- Add Background Modes
- Enable Remote notifications
Configure AppDelegate — call FirebaseApp.configure() (FCM path) and register the ZX_2BTN category for action buttons. Full pattern: Push Notifications and the example AppDelegate. Receive/display/tracking run in JS via Firebase Messaging + notifee.
Upload APNs credentials in the Zixflow dashboard.

Notification Service Extension (rich push)

To support rich push (images) and reliable delivery tracking on iOS, add a Notification Service Extension:

File > New > Target > Notification Service Extension (e.g. NotificationServiceExtension)
Add the rich-push pod for APNs:

target 'NotificationServiceExtension' do
  pod 'zixflow-reactnative-richpush/apn', :path => '../node_modules/zixflow-reactnative'
end

For FCM: zixflow-reactnative-richpush/fcm.

Update NotificationService.swift (canonical snippet — same as the push guide):

import UserNotifications
import ZixflowMessagingPushAPN

class NotificationService: UNNotificationServiceExtension {
  var contentHandler: ((UNNotificationContent) -> Void)?
  var bestAttemptContent: UNMutableNotificationContent?

  override func didReceive(
    _ request: UNNotificationRequest,
    withContentHandler contentHandler: @escaping (UNNotificationContent) -> Void
  ) {
    self.contentHandler = contentHandler
    bestAttemptContent = (request.content.mutableCopy() as? UNMutableNotificationContent)

    MessagingPushAPN.initializeForExtension(
      withConfig: MessagingPushConfigBuilder(apiKey: "YOUR_API_KEY")
        .appGroupId("group.com.yourcompany.yourapp.zixflow")
        .build()
    )
    MessagingPush.shared.didReceive(request, withContentHandler: contentHandler)
  }

  override func serviceExtensionTimeWillExpire() {
    MessagingPush.shared.serviceExtensionTimeWillExpire()
  }
}

Run pod install again.
Add matching App Groups on the host app and NSE, and pass the same .appGroupId(...) from AppDelegate push init.

Location module (optional)

pod 'zixflow-reactnative/location', :path => '../node_modules/zixflow-reactnative'

See Location Tracking.

Android Setup

Gradle Configuration

The React Native auto-linking will handle most of the Android setup. However, you need to ensure the following:

Set minimum SDK version in android/build.gradle:

buildscript {
    ext {
        minSdkVersion = 21
        compileSdkVersion = 34
        targetSdkVersion = 34
    }
}

Add Maven repositories in android/build.gradle:

allprojects {
    repositories {
        google()
        mavenCentral()
        maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' }
    }
}

The Zixflow Android SDK will be automatically included via the React Native module.

Firebase Cloud Messaging Setup

To enable Firebase Cloud Messaging (FCM) for push notifications on Android:

Add Firebase to your project:
- Go to Firebase Console
- Add your Android app (package name must match applicationId in android/app/build.gradle)
- Download the client google-services.json and place it in android/app/
Use the Firebase client config (project_info + client array). Do not put a Firebase service-account JSON in the app.
Add Google Services plugin in android/build.gradle:

buildscript {
    dependencies {
        classpath 'com.google.gms:google-services:4.4.2'
    }
}

Apply the plugin in android/app/build.gradle:

apply plugin: 'com.google.gms.google-services'

Configure push in Zixflow.initialize (Android push module registers from JS init — unlike iOS, you do not initialize push in native Application code for the recommended path):

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

const config: ZixflowConfig = {
  apiKey: 'YOUR_API_KEY',
  logLevel: ZixflowLogLevel.Debug,
  autoTrackDeviceAttributes: true,
  trackApplicationLifecycleEvents: true,
  push: {
    android: {
      pushClickBehavior: PushClickBehaviorAndroid.ActivityPreventRestart,
    },
  },
};

await Zixflow.initialize(config);

Request permission and identify (see Push Notifications):

await Zixflow.identify({ userId: 'user-123', traits: { email: 'user@example.com' } });
await Zixflow.pushMessaging.showPromptForPushNotifications();
const token = await Zixflow.pushMessaging.getRegisteredDeviceToken();

Permissions

Ensure POST_NOTIFICATIONS is available for Android 13+ (the SDK module declares it; your app still prompts at runtime via showPromptForPushNotifications).

Next steps

Full push guide: Push Notifications
Metrics: Push Notification Tracking
Continue with Quick Start

Getting Started

Features

Advanced

Reference

Platform-Specific Setup

iOS Setup

CocoaPods Integration

Push Notification Setup (APNs)

Notification Service Extension (rich push)

Location module (optional)

Android Setup

Gradle Configuration

Firebase Cloud Messaging Setup

Permissions

Next steps

​iOS Setup

​CocoaPods Integration

​Push Notification Setup (APNs)

​Notification Service Extension (rich push)

​Location module (optional)

​Android Setup

​Gradle Configuration

​Firebase Cloud Messaging Setup

​Permissions

​Next steps

iOS Setup

CocoaPods Integration

Push Notification Setup (APNs)

Notification Service Extension (rich push)

Location module (optional)

Android Setup

Gradle Configuration

Firebase Cloud Messaging Setup

Permissions

Next steps