---
updatedAt: 2026-08-25T13:17:47.000Z
agentTools:
  siteIndex: https://documentation.bloomreach.com/llms.txt
  projectIndex: https://documentation.bloomreach.com/engagement/llms.txt
---

# Configuration for React Native SDK

Full configuration reference for the React Native SDK

This page provides an overview of all configuration parameters for the SDK. In addition to the universal parameters, there are Android-specific and iOS-specific parameters.

> 📘
>
> Refer to [Initialize the SDK](https://documentation.bloomreach.com/engagement/docs/react-native-sdk-setup#initialize-the-sdk) for instructions.

## Configuration parameters

The following parameters are specified in an `Configuration` object. Refer to [src/Configuration.ts](https://github.com/exponea/exponea-react-native-sdk/blob/main/src/Configuration.ts) for the complete interface definition.

* `integrationConfig` **(required in new integrations)**

  * Use this property to set your integration configuration.
  * Use `ProjectConfig` to set up integration with a standard Marketing project, or `StreamConfig` to set up Data hub [event stream](https://documentation.bloomreach.com/data-hub/docs/event-streams) integration.
  * `ProjectConfig` fields:
    * `projectToken` **(required)**: your Marketing project token, found in the Marketing web app under **Project settings** > **Access management** > **API**
    * `authorizationToken` **(required)**: your Marketing public API key; must be a **public** key (see [Mobile SDKs API Access Management](https://documentation.bloomreach.com/engagement/docs/mobile-sdks-api-access-management))
    * `baseUrl`: API base URL; defaults to `https://api.exponea.com`
  * `StreamConfig` fields:
    * `streamId` **(required)**: your Data hub stream ID, found in the Data hub app under **Event streams** > select your stream > **Access Security**
    * `baseUrl`: base URL override for the stream endpoint; defaults to `https://api.exponea.com`
  * The two modes are mutually exclusive; you can't provide both `projectToken` and `streamId` in the same `integrationConfig`.
  * Example with `ProjectConfig`:
    ```typescript
    integrationConfig: {
      projectToken: 'YOUR_PROJECT_TOKEN',
      authorizationToken: 'YOUR_API_KEY',
      baseUrl: 'https://api.exponea.com',
    }
    ```
  * Example with `StreamConfig`:
    ```typescript
    integrationConfig: {
      streamId: 'YOUR_STREAM_ID',
      baseUrl: 'https://api.exponea.com',
    }
    ```

* `projectToken` **(deprecated — use `integrationConfig` with `ProjectConfig` instead)**

  * Your project token. You can find this in the Marketing web app under **Project settings** > **Access management** > **API**.

* `authorizationToken` **(deprecated — use `integrationConfig` with `ProjectConfig` instead)**

  * Your Marketing API key.
  * The token must be an Marketing **public** key. See [Mobile SDKs API Access Management](https://documentation.bloomreach.com/engagement/docs/mobile-sdks-api-access-management) for details.
  * For more information, refer to Marketing [API documentation](https://documentation.bloomreach.com/engagement/reference/welcome#access-keys).

* `baseUrl` **(deprecated — use `integrationConfig` with `ProjectConfig` instead)**

  * Your API base URL which can be found in the Marketing web app under **Project settings** > **Access management** > **API**.
  * Default value `https://api.exponea.com`.
  * If you have custom base URL, you must set this property.

* `integrationRouteMap`
  * To track specific events to additional Marketing projects, define a mapping between event types and `ProjectConfig` objects.
  * The SDK always tracks each event to the default project and any projects it's mapped to.
  * **Applies only when `integrationConfig` is a `ProjectConfig`.** Ignored for `StreamConfig`.
  * Example:
    ```typescript
    integrationRouteMap: {
      [EventType.BANNER]: [
        {
          projectToken: 'other-project-token',
          authorizationToken: 'other-auth-token',
        },
      ],
    }
    ```

* `projectMapping` **(deprecated — use `integrationRouteMap` with `ProjectConfig` instead)**
  * If you need to track some events to a different Marketing project, you can define a mapping between event types and Marketing projects.
  * The SDK always tracks each event to the default project and any projects it's mapped to.
  * Example:
    ```typescript
    projectMapping: {
      [EventType.BANNER]: [
        {
          projectToken: 'other-project-token',
          authorizationToken: 'other-auth-token',
        },
      ],
    }
    ```

* `defaultProperties`

  * A list of properties to include in all tracking events.
  * You can change these properties at runtime by calling `Exponea.setDefaultProperties()`.

* `allowDefaultCustomerProperties`

  * Flag to apply the `defaultProperties` list to `identifyCustomer` tracking events.
  * Default value: `true`

* `automaticSessionTracking`

  * Flag to control the automatic tracking of `session_start` and `session_end` events.
  * Default value: `true`

* `requirePushAuthorization` **(deprecated — use `ios.requirePushAuthorization` instead)**
  * This property no longer has any effect on Android. Use `ios.requirePushAuthorization` for iOS-specific behavior.
  * Default value: `true`

* `sessionTimeout`

  * The session is the actual time spent in the app. It starts when the app is launched and ends when the app goes into the background.
  * When the application goes into the background, the SDK doesn't track the end of the session right away but waits a bit for the user to come back before doing so. You can configure the timeout by setting this property.
  * Read more about [tracking sessions](https://documentation.bloomreach.com/engagement/docs/react-native-sdk-tracking#session).
  * Default value: `60`

* `pushTokenTrackingFrequency`

  * Indicates the frequency with which the SDK should track the push notification token to Marketing.
  * Default value: `ON_TOKEN_CHANGE`
  * Possible values:
    * `ON_TOKEN_CHANGE` - tracks the push token if it differs from a previously tracked one. The SDK also automatically refreshes the `notification_state` event every 30 days, even when the token hasn't changed.
    * `EVERY_LAUNCH` - tracks the push token once per app launch (process start). Some operations always trigger tracking regardless of this setting: manual `trackPushToken()` calls, receiving a new token from FCM/HMS/APNs, and calling `anonymize()` or `stopIntegration()`.
    * `DAILY` - tracks push token once per day

* `flushMaxRetries`

  * Controls how many times the SDK should attempt to flush an event before aborting. Useful for example in case the API is down or some other temporary error happens.
  * The SDK will consider the data to be flushed if this number is exceeded and delete the data from the queue.
  * Default value: `10`

* `advancedAuthEnabled`

  * If set, advanced authorization is used for communication with the Marketing APIs listed in [Customer token authorization](https://documentation.bloomreach.com/engagement/docs/react-native-sdk-authorization#customer-token-authorization).
  * Refer to the [authorization documentation](https://documentation.bloomreach.com/engagement/docs/react-native-sdk-authorization) for details.
  * **Only applicable when `integrationConfig` is a `ProjectConfig`.** If set to `true` with a `StreamConfig` integration, the SDK logs a warning and ignores the setting. For stream-based integrations, refer to [SDK auth token authorization](https://documentation.bloomreach.com/engagement/docs/react-native-sdk-authorization#sdk-auth-token-authorization).

* `inAppContentBlockPlaceholdersAutoLoad`

  * Automatically load the contents of in-app content blocks assigned to these Placeholder IDs.

* `manualSessionAutoClose`
  * Determines whether the SDK automatically tracks `session_end` for sessions that remain open when `Exponea.trackSessionStart()` is called multiple times in manual session tracking mode.
  * Default value: `true`

* `applicationId`

  * This `applicationId` defines a unique identifier for the mobile app within the Marketing project. Change this value only if your Marketing project contains and supports multiple mobile apps.
  * This identifier distinguishes between different apps in the same project.
  * Your `applicationId` value must be the same as the one defined in your Marketing project settings.
  * If your Marketing project supports only one app, skip the `applicationId` configuration. The SDK will use the default value automatically.
  * Must be in a specific format, see rules:
    * Starts with one or more lowercase letters or digits
    * Additional words are separated by single hyphens or dots
    * No leading or trailing hyphens or dots
    * No consecutive hyphens or dots
    * Maximum length is 50 characters
    * E.g. `com.example.myapp`, `com-example-myapp`, `my-application1`
  * Default value: `default-application`

* `regenerateDeviceIdOnAnonymize`

  * If `true`, calling `Exponea.anonymize()` generates a new `device_id` for the new anonymous customer profile, so the device identifier no longer links the new profile to the previous customer's events.
  * Set this to `true` when your privacy requirements call for a sign-out flow that produces two unlinkable customer profiles. The default (`false`) preserves the existing behaviour where `device_id` persists across `anonymize()` calls.
  * Default value: `false`

* `android`

  * `AndroidConfiguration` object containing [Android-specific configuration parameters](#android-specific-configuration-parameters).

* `ios`
  * `IOSConfiguration` object containing [iOS-specific configuration parameters](#ios-specific-configuration-parameters).

### Android-specific configuration parameters

The following parameters are specified in an `AndroidConfiguration` object. Refer to [src/Configuration.ts](https://github.com/exponea/exponea-react-native-sdk/blob/main/src/Configuration.ts) for the complete interface definition.

* `requirePushAuthorization` **(deprecated)**
  * This property has no effect on Android. The SDK always tracks the push token. The `valid` and `description` properties in the `notification_state` event reflect the actual OS notification permission state.

* `automaticPushNotifications`

  * By default, the SDK will set up a Firebase service and try to process push notifications sent from the Marketing platform automatically. You can opt out by setting this to `false`.
  * Default value: `true`

* `pushIcon`

  * Android resource ID of the icon to be used for push notifications.

* `pushIconResourceName`

  * Android resource name of the icon to be used for push notifications. For example, if file `push_icon.png` is placed in your drawable of mipmap resources folder, use the filename without extension as a value.

* `pushAccentColor`

  * Accent color of push notification icon and buttons, specified as Color ARGB integer.

* `pushAccentColorRGBA`

  * Accent color of push notification icon and buttons, specified by RGBA channels separated by comma.
  * For example, to use the color blue, the string `"0, 0, 255, 255"` should be entered.

* `pushAccentColorName`

  * Accent color of push notification icon and buttons, specified by resource name.
  * Any color defined in R class can be used.
  * For example, if you defined your color as a resource `<color name="push_accent_color">#0000ff</color>`, use `push_accent_color` as a value for this parameter.

* `pushChannelName`

  * Name of the channel to be created for the push notifications.
  * Only available for API level 26+. Refer to <https://developer.android.com/training/notify-user/channels> for details.

* `pushChannelDescription`

  * Description of the channel to be created for the push notifications.
  * Only available for API level 26+. Refer to <https://developer.android.com/training/notify-user/channels> for details.

* `pushChannelId`

  * Channel ID for push notifications.
  * Only available for API level 26+. Refer to <https://developer.android.com/training/notify-user/channels> for details.

* `pushNotificationImportance`

  * Notification importance for the notification channel.
  * Only available for API level 26+. Refer to <https://developer.android.com/training/notify-user/channels> for details.

* `httpLoggingLevel`
  * Level of HTTP request/response logging.

### iOS-specific configuration parameters

The following parameters are specified in an `IOSConfiguration` object. Refer to [src/Configuration.ts](https://github.com/exponea/exponea-react-native-sdk/blob/main/src/Configuration.ts) for the complete interface definition.

* `requirePushAuthorization`
  * Controls whether the SDK calls `registerForRemoteNotifications()` automatically based on the OS-reported notification authorization status.
  * When `true` (default), the SDK only calls `registerForRemoteNotifications()` once the OS reports `authorized` or `provisional` status ([Apple documentation](https://developer.apple.com/documentation/usernotifications/unnotificationsettings/1648391-authorizationstatus)). Use this when your app should receive an APNs token only after the user grants notification permission.
  * When `false`, the SDK calls `registerForRemoteNotifications()` unconditionally on every launch, allowing the app to receive silent pushes regardless of the user's visible notification permission state.
  * The `valid` field in `notification_state` events always reflects the actual OS authorization status, regardless of your `requirePushAuthorization` setting.
  * Default value: `true`

* `appGroup`
  * App group used for communication between the main app and notification extensions. This is a required field for rich push notification setup.