Push Notification Tracking

Last Updated: July 2, 2026
Audience: Client developers integrating Zixflow SDK (React Native)
Purpose: Track push notification lifecycle events — delivery, open, and action clicks — so Zixflow can measure campaign performance accurately. See also: Push Notifications and the reference implementation src/pushHandlers.ts.

Why Push Tracking Matters

When Zixflow sends a push notification to a user’s device, it records that the notification was sent. But it cannot know on its own:

Did the notification actually arrive on the device?
Did the user open it (tap the banner)?
Did the user tap an action button (“Shop Now”, “Remind Me”)?

Your app reports these three moments back to Zixflow using the SDK. This powers the delivery analytics you see in campaign dashboards — open rates, click rates, and conversion funnels after a push.

The Delivery Lifecycle at a Glance

Zixflow Campaign ──sends──▶ Zixflow (via FCM/APNs) ──delivers──▶ Device OS
                                                                │
                                                     ┌──────────┴──────────┐
                                                     │                     │
                                               App foreground        App background
                                               onMessage()           onMessageOpenedApp()
                                                     │                     │
                                            Your app calls:          Your app calls:
                                         trackMetric(delivered)   trackMetric(opened)
                                                     │
                                          User taps action button
                                                     │
                                             Your app calls:
                                        track("Push Notification
                                           Action Clicked")

Each of these SDK calls results in a delivery report event flowing to the Zixflow backend, updating the campaign’s live metrics.

The Push Payload

Zixflow injects two special fields into every push notification’s data payload. Your app uses these to associate the tracking event with the correct campaign delivery.

Field	Example value	Purpose
`Zixflow-Delivery-ID`	`"626533406292836846"`	Unique ID for this delivery (matches campaign record)
`Zixflow-Delivery-Token`	`"dcFRlDhiRbehM1vg-Lx_yn:..."`	The FCM/APNs token the notification was sent to

These appear inside message.data (React Native). The SDK’s trackMetric() method requires both to route the event correctly. Example raw data payload received by the app:

{
  "Zixflow-Delivery-ID": "626533406292836846",
  "Zixflow-Delivery-Token": "dcFRlDhiRbehM1vg...",
  "title": "Flash Sale! 70% OFF 🔥",
  "body": "Limited time only — grab your deal now!",
  "deeplink_url": "https://yourapp.com/sale",
  "image_url": "https://cdn.yourapp.com/banner.png",
  "large_icon_url": "https://cdn.yourapp.com/icon.png",
  "badge": "5",
  "action_buttons": "[{\"name\":\"Shop Now\",\"deeplink\":\"https://yourapp.com/sale\"},{\"name\":\"Remind Me\",\"deeplink\":\"\"}]",
  "notif_id": "626533406292836846"
}

Important: action_buttons is a JSON string (not a nested object). Parse it with JSON.parse before use.

The Three Tracking Events

1. Delivery Confirmed

Event name (sent to Zixflow): Push Notification Delivered
When to fire: The moment the push data payload arrives on the device — inside your onMessage handler.
SDK method: Zixflow.trackMetric({ deliveryID, deviceToken, event: MetricEvent.delivered })
What happens: Zixflow updates the campaign delivery record to delivered. No profile event is stored. Parameters:

Parameter	Required	Description
`deliveryID`	✅	Value of `Zixflow-Delivery-ID` from the push payload
`deviceToken`	✅	Value of `Zixflow-Delivery-Token` from the push payload (or your cached FCM/APNs token)
`event`	✅	`MetricEvent.delivered`

import messaging from '@react-native-firebase/messaging';
import { Zixflow, MetricEvent } from 'zixflow-reactnative';

messaging().onMessage(async remoteMessage => {
  const deliveryId    = remoteMessage.data?.['Zixflow-Delivery-ID'] ?? '';
  const deliveryToken = remoteMessage.data?.['Zixflow-Delivery-Token'] ?? cachedToken ?? '';

  if (deliveryId && deliveryToken) {
    await Zixflow.trackMetric({
      deliveryID:  deliveryId,
      deviceToken: deliveryToken,
      event:       MetricEvent.delivered,
    });
  }
});

2. Notification Opened

Event name (sent to Zixflow): Push Notification Opened
When to fire: When the user taps the notification banner. Fire for both body taps and action button taps.
SDK method: Zixflow.trackMetric({ deliveryID, deviceToken, event: MetricEvent.opened })
What happens: Zixflow updates the campaign delivery record to opened. No profile event is stored. Parameters:

Parameter	Required	Description
`deliveryID`	✅	Value of `Zixflow-Delivery-ID` from the push payload
`deviceToken`	✅	Value of `Zixflow-Delivery-Token` from the push payload
`event`	✅	`MetricEvent.opened`

import messaging from '@react-native-firebase/messaging';
import { Zixflow, MetricEvent } from 'zixflow-reactnative';

// Background / quit tap
messaging().onNotificationOpenedApp(async remoteMessage => {
  const deliveryId    = remoteMessage.data?.['Zixflow-Delivery-ID'] ?? '';
  const deliveryToken = remoteMessage.data?.['Zixflow-Delivery-Token'] ?? cachedToken ?? '';

  if (deliveryId && deliveryToken) {
    await Zixflow.trackMetric({ deliveryID: deliveryId, deviceToken: deliveryToken, event: MetricEvent.opened });
  }
});

// Terminated tap
const initial = await messaging().getInitialNotification();
if (initial) {
  const deliveryId    = initial.data?.['Zixflow-Delivery-ID'] ?? '';
  const deliveryToken = initial.data?.['Zixflow-Delivery-Token'] ?? cachedToken ?? '';

  if (deliveryId && deliveryToken) {
    await Zixflow.trackMetric({ deliveryID: deliveryId, deviceToken: deliveryToken, event: MetricEvent.opened });
  }
}

3. Action Button Clicked

Event name (sent to Zixflow): Push Notification Action Clicked
When to fire: When the user taps a named action button (“Shop Now”, “Try It Free”, etc.). Always fire trackMetric(opened) first, then fire this event.
SDK method: Zixflow.track({ name: "Push Notification Action Clicked", properties: {...} })
What happens: Zixflow records a clicked delivery report and captures which button was tapped for campaign analytics.

This is a named track() call — not trackMetric(). There is no MetricEvent enum for clicks.

Properties:

Property	Type	Required	Description
`Zixflow-Delivery-ID`	string	✅	Links this event to the campaign delivery record
`action_index`	integer	✅	0-based index of the button tapped (`0` = first button)
`action_name`	string	✅	Human-readable button label (e.g. `"Shop Now"`)
`Zixflow-Delivery-Token`	string	Recommended	Token push was sent to
`action_deeplink`	string	Recommended	URL the button navigates to
`title`	string	Optional	Notification title
`action_id`	string	Optional	OS-level action identifier (e.g. `"action_0"`)
`source`	string	Optional	`"local_notification"` or `"web_push"`

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

async function handleActionPress(data: Record<string, string>, actionId: string) {
  const deliveryId  = data['Zixflow-Delivery-ID'] ?? '';
  const token       = data['Zixflow-Delivery-Token'] ?? '';
  const actionIndex = parseInt(actionId.replace(/\D/g, ''), 10);
  const buttons     = parseButtons(data['action_buttons']);
  const actionName  = buttons[actionIndex]?.name ?? `Action ${actionIndex + 1}`;
  const actionDeep  = buttons[actionIndex]?.deeplink ?? '';

  // Always fire opened first
  await Zixflow.trackMetric({ deliveryID: deliveryId, deviceToken: token, event: MetricEvent.opened });

  // Then fire action clicked
  await Zixflow.track({
    name: 'Push Notification Action Clicked',
    properties: {
      'Zixflow-Delivery-ID':    deliveryId,
      'Zixflow-Delivery-Token': token,
      'action_index':           actionIndex,
      'action_name':            actionName,
      'action_deeplink':        actionDeep,
    },
  });
}

Action Buttons Format

The action_buttons field in the push payload is a JSON-encoded string containing an array of button objects. You must parse it before use. Payload value (raw string):

"[{\"name\":\"Shop Now\",\"deeplink\":\"https://yourapp.com/sale\"},{\"name\":\"Remind Me\",\"deeplink\":\"\"}]"

Parsed structure:

[
  { "name": "Shop Now",  "deeplink": "https://yourapp.com/sale" },
  { "name": "Remind Me", "deeplink": "" }
]

Rules:

Maximum 2 buttons per notification
deeplink may be an empty string — handle gracefully, don’t navigate to a blank URL
Button index is 0-based
On iOS, button labels are pre-registered at app init — use categoryId: 'ZX_2BTN'

Parsing `action_buttons`

interface ActionButton {
  name: string;
  deeplink: string;
}

function parseActionButtons(raw: string | undefined): ActionButton[] {
  if (!raw) return [];
  try {
    const decoded = JSON.parse(raw);
    return (Array.isArray(decoded) ? decoded : []).slice(0, 2);
  } catch {
    return [];
  }
}

Building the Buttons on the Notification (notifee)

// pushHandlers.ts pattern
function buildNotifeeActions(data: Record<string, string | undefined>) {
  const buttons = parseActionButtons(data.action_buttons);
  return buttons.slice(0, 2).map((button, index) => ({
    title: button.name || `Action ${index + 1}`,
    pressAction: { id: `action_${index}` },
  }));
}

await notifee.displayNotification({
  title,
  body,
  data,
  android: {
    channelId: ANDROID_CHANNEL_ID,
    pressAction: { id: 'default' },
    actions: buildNotifeeActions(data),   // ← dynamic buttons attached here
  },
  ios: {
    categoryId: 'ZX_2BTN',   // ← same pre-registered category as native iOS
  },
});

notifee.onForegroundEvent / notifee.onBackgroundEvent’s detail.pressAction.id (e.g. "action_0") is parsed back into an index for tracking.

Handling the Tap (End-to-End)

Platform	Callback	Identifier format	Resolve to index
React Native	`notifee.onForegroundEvent` / `onBackgroundEvent`	`detail.pressAction.id` = `"action_0"` / `"action_1"`	`parseInt(id.replace(/\D/g, ''), 10)`

Important on Android (React Native): pressing an action button does not automatically dismiss the notification — see Sticky Notifications below.

Sticky Notifications

Field: sticky (boolean, sent in the data.* payload as the string "true" / "false") This is Android-only — there is no iOS/APNs equivalent.

const sticky = data.sticky === 'true';

await notifee.displayNotification({
  title,
  body,
  data,
  android: {
    channelId: ANDROID_CHANNEL_ID,
    autoCancel: true,   // always true — body tap always dismisses
    ongoing: sticky,     // true = survives swipe + "Clear all"
  },
});

// In your notifee event handler, after tracking the action click:
if (type === EventType.ACTION_PRESS && detail.pressAction) {
  // Required regardless of `sticky` — action buttons never auto-dismiss on Android.
  if (detail.notification?.id) {
    notifee.cancelNotification(detail.notification.id);
  }
}

Same reasoning as Flutter: React Native’s Zixflow SDK is a thin JS wrapper with no native background message interception, so @react-native-firebase/messaging + notifee is what actually displays the notification in your app code — sticky must be read and applied there.

Deep Link Handling

Every Zixflow push notification may carry a deeplink_url at the top level and per-button deeplinks in action_buttons. Your app is responsible for routing these to the right in-app screen. Priority order for navigation on tap:

If an action button was tapped → use action_buttons[index].deeplink
If body was tapped → use deeplink_url
If neither is set → open app to default screen

// navigation.ts
export function resolveInAppRoute(deeplink?: string): boolean {
  if (!deeplink) return false;
  let url: URL;
  try { url = new URL(deeplink); } catch { return false; }
  if (url.protocol !== 'zixflowdemo:') return false;

  switch (url.hostname) {
    case 'sale':      navigate('Sale');      return true;
    case 'dashboard': navigate('Dashboard'); return true;
    default:          return false;
  }
}

// pushHandlers.ts
import { Linking } from 'react-native';
import { resolveInAppRoute } from './navigation';

function handleDeeplink(url?: string) {
  if (!url) return;
  if (resolveInAppRoute(url)) return;   // handled by one of our own screens
  Linking.openURL(url).catch(() => {}); // fall back to external browser/app
}

Decision Flowchart

Notification received?
├── YES → trackMetric(delivered)        [always, as soon as data payload arrives]
│
User interacted?
├── Tapped notification body
│   └── trackMetric(opened)             [SDK call with deliveryID + deviceToken]
│       └── Navigate to deeplink_url
│
└── Tapped action button
    ├── trackMetric(opened)             [still track opened]
    └── track("Push Notification Action Clicked")  [with action_index + action_name]
        └── Navigate to button's deeplink

Fallback Behaviour (No Zixflow-Delivery-ID)

If the push notification was sent by a non-Zixflow source, Zixflow-Delivery-ID and Zixflow-Delivery-Token will be absent from the payload. In this case, skip trackMetric(). Push notification event names are reserved for Zixflow’s delivery pipeline — they are not stored as user profile events. If you want to track a non-Zixflow push for your own analytics, use a custom event name instead.

Testing

const config = {
  apiKey: 'YOUR_API_KEY',
  logLevel: ZixflowLogLevel.Debug,
};
await Zixflow.initialize(config);

Dashboard → Messaging → Push Notifications: Sent / Delivered / Opened / Clicked.

Getting Started

Features

Advanced

Reference

Push Notification Tracking

Why Push Tracking Matters

The Delivery Lifecycle at a Glance

The Push Payload

The Three Tracking Events

1. Delivery Confirmed

2. Notification Opened

3. Action Button Clicked

Action Buttons Format

Parsing `action_buttons`

Building the Buttons on the Notification (notifee)

Handling the Tap (End-to-End)

Sticky Notifications

Deep Link Handling

Decision Flowchart

Fallback Behaviour (No Zixflow-Delivery-ID)

Testing

​Why Push Tracking Matters

​The Delivery Lifecycle at a Glance

​The Push Payload

​The Three Tracking Events

​1. Delivery Confirmed

​2. Notification Opened

​3. Action Button Clicked

​Action Buttons Format

​Parsing action_buttons

​Building the Buttons on the Notification (notifee)

​Handling the Tap (End-to-End)

​Sticky Notifications

​Deep Link Handling

​Decision Flowchart

​Fallback Behaviour (No Zixflow-Delivery-ID)

​Testing

Why Push Tracking Matters

The Delivery Lifecycle at a Glance

The Push Payload

The Three Tracking Events

1. Delivery Confirmed

2. Notification Opened

3. Action Button Clicked

Action Buttons Format

Parsing `action_buttons`

Building the Buttons on the Notification (notifee)

Handling the Tap (End-to-End)

Sticky Notifications

Deep Link Handling

Decision Flowchart

Fallback Behaviour (No Zixflow-Delivery-ID)

Testing