In-App Messaging

In-App Messaging: getInAppMessaging, suppress display, automatic data collection, triggerEvent, SDK_VERSION, Analytics peer, and firebase.json auto-collection. Not Cloud Messaging.

Prerequisites

  • @react-native-firebase/app installed and native config completed per Getting Started (Android google-services.json, iOS GoogleService-Info.plist, Expo config plugin, or React Native CLI setup). From v26, New Architecture is required for packages with a native bridge.
  • @react-native-firebase/analytics installed. In-App Messaging lists Analytics as a peer dependency (Google Analytics must be enabled on the Firebase project).
  • Install In-App Messaging: npm install --save @react-native-firebase/in-app-messaging or yarn add @react-native-firebase/in-app-messaging, then rebuild native apps (cd ios && pod install on iOS).
  • Author campaigns in the Firebase Console In-App Messaging tab before expecting messages on device. This package is not Cloud Messaging (@react-native-firebase/messaging / FCM).

Example Expo Router screen: https://github.com/invertase/react-native-firebase/blob/main/test-expo/app/in-app-messaging.tsx

Installation

This module requires that the @react-native-firebase/app module is already setup and installed. To install the "app" module, view the Getting Started documentation.

This module also requires that the @react-native-firebase/analytics module is already setup and installed. To install the "analytics" module, view its Getting Started documentation.

bash
# Install & setup the app module
yarn add @react-native-firebase/app

# Install the analytics module (peer dependency)
yarn add @react-native-firebase/analytics

# Install the in-app-messaging module
yarn add @react-native-firebase/in-app-messaging

# If you're developing your app using iOS, run this command
cd ios/ && pod install

Platform support and New Architecture

{/* prettier-ignore */}

PlatformsAndroid, iOS (native Firebase SDK). On web builds a JavaScript fallback is used: every call resolves without reaching native code and both flags start as false.
New ArchitectureRequired from v26. See Migrating to v26.

Platform notes: The firebase-js-sdk does not ship a modular public API for this product (firebase/in-app-messaging does not exist). Every export below is React Native Firebase only. In-App Messaging supports only the default Firebase app (hasMultiAppSupport: false). There is no In-App Messaging emulator and no connect*Emulator helper for this package. Do not confuse this package with Cloud Messaging.

React Native Firebase exports runtime getInAppMessaging, isMessagesDisplaySuppressed, setMessagesDisplaySuppressed, isAutomaticDataCollectionEnabled, setAutomaticDataCollectionEnabled, triggerEvent, and SDK_VERSION, plus the TypeScript type InAppMessaging. Each runtime export is explained in the section that uses it. The type-only export is for typing only and is not demonstrated on the Expo screen.

Official Firebase docs and what this page leaves out

Related official pages:

Left out of this page (each with a reason):

  • Native click / impression / display-error listeners (Android FirebaseInAppMessagingClickListener and related; iOS InAppMessagingDisplayDelegate): not exported by @react-native-firebase/in-app-messaging.
  • Campaign custom metadata access on the client: requires those native callbacks; no modular RN entry point.
  • Custom messageDisplayComponent / custom display libraries and cloning firebase-ios-sdk default displays: native UI customization; not part of this package's modular surface.
  • Deep link / Dynamic Links action handlers: app-level linking setup outside this module. Compose action URLs in the console; handle links with your app's navigator.
  • Full console compose, targeting, scheduling, conversion events, publish/draft, and Gemini AI campaign insights: Firebase console workflows. Summarized below; detail stays on official compose docs.
  • A/B Testing experiments with In-App Messaging: console / A/B Testing product, not this client API.
  • Flutter get-started guides: wrong client platform for this package.
  • Test-on-device console steps beyond needing a Firebase installation ID: use @react-native-firebase/installations getId (or the native log lines from the get-started guides: the FIAM.Headless log tag on Android, -FIRDebugEnabled on iOS) plus the console Test on Device flow. After the console sends the test message, close and reopen the app to see it.

What does it do

Firebase In-App Messaging helps you engage your app's active users by sending them targeted, contextual messages that encourage them to use key app features. For example, you could send an in-app message to get users to subscribe, watch a video, complete a level, or buy an item. You can customize messages as cards, banners, modals, or images, and set up triggers so that they appear exactly when they'd benefit your users most.

Most setup happens in the Firebase Console. Published campaigns are fetched and displayed by the native SDKs. This module exposes a small JavaScript API to suppress display, control automatic data collection, and trigger campaigns programmatically.

Limitations

Firebase In-App Messaging allows only one campaign per day on app foreground or app launch triggers (see firebase-ios-sdk#4768). That limit reduces accidental overload for non-contextual messages. Contextual triggers (Analytics events or programmatic triggerEvent) are not subject to that daily foreground/launch rate limit.

Native SDKs also fetch campaigns on a low-frequency schedule (about once per day) to conserve power. Use the console Test on Device flow with a device Firebase installation ID when iterating.

Usage

Create and publish campaigns under In-App Messaging in the Firebase Console (style, targeting, schedule, trigger events). Eligible devices show messages when a trigger fires and display is not suppressed.

Get an In-App Messaging instance

getInAppMessaging(app?) returns the InAppMessaging instance for the default app, or for the FirebaseApp you pass. This module does not support secondary Firebase apps: passing a non-default app throws. Prefer omitting app or passing getApp().

js
import { getApp } from '@react-native-firebase/app';
import { getInAppMessaging } from '@react-native-firebase/in-app-messaging';

function readInAppMessagingInstance() {
  const inAppMessaging = getInAppMessaging();
  const sameDefaultApp = getInAppMessaging(getApp());
  console.log('Default app name:', inAppMessaging.app.name);
  console.log('Same instance for default app:', sameDefaultApp === inAppMessaging);
  return inAppMessaging;
}

Suppress message display

isMessagesDisplaySuppressed(inAppMessaging) reports whether rendering is suppressed. setMessagesDisplaySuppressed(inAppMessaging, enabled) enables or disables suppression. The check reads a value held in JavaScript: it is the native value when the instance was created, then whatever you last passed to setMessagesDisplaySuppressed, and it updates before the native call finishes.

When enabled is true, no in-app messages render until you set it back to false or the app restarts. Suppression is not persisted across restarts. Messages whose trigger fires while suppression is on are dropped, so their trigger conditions must be met again after you turn suppression off. Call it as early as possible if you need messages hidden during bootstrap (for example payment flows).

setMessagesDisplaySuppressed throws an Error synchronously (it does not return a rejected promise) if enabled is not a boolean.

js
import {
  getInAppMessaging,
  isMessagesDisplaySuppressed,
  setMessagesDisplaySuppressed,
} from '@react-native-firebase/in-app-messaging';

async function suppressDuringBootstrap() {
  const inAppMessaging = getInAppMessaging();
  await setMessagesDisplaySuppressed(inAppMessaging, true);
  console.log('Suppressed:', isMessagesDisplaySuppressed(inAppMessaging));
}

async function allowMessagesAfterSetup() {
  const inAppMessaging = getInAppMessaging();
  await setMessagesDisplaySuppressed(inAppMessaging, false);
  console.log('Suppressed:', isMessagesDisplaySuppressed(inAppMessaging));
}

Automatic data collection

isAutomaticDataCollectionEnabled(inAppMessaging) reports whether automatic data collection is on. setAutomaticDataCollectionEnabled(inAppMessaging, enabled) enables or disables it at runtime.

This setting is persisted across app restarts and overrides the startup value from your native configuration (the Info.plist key on iOS, the manifest entry on Android). The check reads a value held in JavaScript, the same way as the suppression check above. Use it for opt-in-first flows (for example GDPR): turn collection off at startup, then enable it after the user consents.

setAutomaticDataCollectionEnabled throws an Error synchronously (it does not return a rejected promise) if enabled is not a boolean.

js
import {
  getInAppMessaging,
  isAutomaticDataCollectionEnabled,
  setAutomaticDataCollectionEnabled,
} from '@react-native-firebase/in-app-messaging';

async function enableCollectionAfterConsent() {
  const inAppMessaging = getInAppMessaging();
  await setAutomaticDataCollectionEnabled(inAppMessaging, true);
  console.log('Collection enabled:', isAutomaticDataCollectionEnabled(inAppMessaging));
}

async function disableCollection() {
  const inAppMessaging = getInAppMessaging();
  await setAutomaticDataCollectionEnabled(inAppMessaging, false);
  console.log('Collection enabled:', isAutomaticDataCollectionEnabled(inAppMessaging));
}

Trigger an event programmatically

triggerEvent(inAppMessaging, eventId) requests any eligible campaigns whose programmatic trigger matches eventId. Create or note that event ID in the campaign Scheduling step in the console, then call triggerEvent with the same string.

Campaigns can also use trigger events that Google Analytics collects. The compose campaign guide says you can pick default events or events logged through Analytics, and the message is triggered when any of the campaign's events occur. Events you log with the Analytics logEvent function therefore need no triggerEvent call.

triggerEvent throws an Error synchronously (it does not return a rejected promise) if eventId is not a string. The returned promise resolves once the native call has been made, whether or not a campaign matches or is displayed.

js
import { getInAppMessaging, triggerEvent } from '@react-native-firebase/in-app-messaging';

async function fireCampaignTrigger() {
  const inAppMessaging = getInAppMessaging();
  await triggerEvent(inAppMessaging, 'exampleTrigger');
  console.log('Triggered exampleTrigger');
}

Types only (not runtime)

InAppMessaging is a TypeScript interface re-exported from @react-native-firebase/in-app-messaging for annotating the value returned by getInAppMessaging. It has no runtime value. Keep it out of the Expo example screen; import it with import type only when you need annotations in TypeScript source.

firebase.json

Disable collection of data

Set in_app_messaging_auto_collection_enabled in the project-root firebase.json so iOS builds start with automatic data collection off: the build copies the flag into the FirebaseInAppMessagingAutomaticDataCollectionEnabled key of your Info.plist. Override later with setAutomaticDataCollectionEnabled.

On Android the package writes the same flag into a manifest meta-data entry (and a firebase.json value of app_data_collection_default_enabled: false also turns the default off there), but the Firebase Android SDK documents a different manifest key, firebase_inapp_messaging_auto_data_collection_enabled. If collection must be off before any JavaScript runs on Android, add that key to your own AndroidManifest.xml as described in the official modify message behavior page.

json
// <project-root>/firebase.json
{
  "react-native": {
    "in_app_messaging_auto_collection_enabled": false
  }
}

Package version

SDK_VERSION is the React Native Firebase In-App Messaging package version string exported from @react-native-firebase/in-app-messaging. The firebase-js-sdk does not export SDK_VERSION from a firebase/in-app-messaging entry point (that modular product does not exist).

js
import { SDK_VERSION } from '@react-native-firebase/in-app-messaging';

console.log('In-App Messaging package version:', SDK_VERSION);