HomeEngagementOther resources
Guides

Configuration for React Native SDK

Full configuration reference for the React Native SDK

Suggest Edits

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 for instructions.

Configuration parameters

The following parameters are specified in an Configuration object. Refer to src/Configuration.ts for the complete interface definition.

  • projectToken (required)

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

  • authorizationToken (required)

  • baseUrl

    • Your API base URL which can be found in the Engagement 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.

  • projectMapping

    • If you need to track some events to a different Engagement project, you can define a mapping between event types and Engagement projects.
    • An event is always tracked to the default project and any projects it is mapped to.
    • Example: 
      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

  • 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.
    • Default value: 60

  • pushTokenTrackingFrequency

    • Indicates the frequency with which the SDK should track the push notification token to Engagement.
    • Default value: ON_TOKEN_CHANGE
    • Possible values:
      • ON_TOKEN_CHANGE - tracks push token if it differs from a previously tracked one
      • EVERY_LAUNCH - always tracks push token
      • DAILY - tracks push token once per day

  • requirePushAuthorization

    • When true, the SDK only tracks the push token if the user has granted notification permission; otherwise the notification_state event is tracked with valid = false and a description such as "Permission denied". When false, the token is tracked regardless of permission (e.g. for silent push).
    • Applied on both iOS and Android. Can be set at root level (same value for both platforms) or overridden per platform via ios.requirePushAuthorization or android.requirePushAuthorization.
    • Default value: true

  • 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

  • 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 Engagement project. Change this value only if your Engagement 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 Engagement project settings.
    • If your Engagement 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

  • android

  • ios

Android-specific configuration parameters

The following parameters are specified in an AndroidConfiguration object. Refer to src/Configuration.ts for the complete interface definition.

  • requirePushAuthorization

    • Same as the root-level parameter. When set in android, it overrides the root value for Android only. Affects notification_state event behavior (e.g. "Permission denied" when user has not granted notification permission).
    • Default value: true

  • automaticPushNotifications

    • By default, the SDK will set up a Firebase service and try to process push notifications sent from the Engagement 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

  • pushChannelDescription

  • pushChannelId

  • pushNotificationImportance

  • 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 for the complete interface definition.

  • requirePushAuthorization

    • Same as the root-level parameter. When set in ios, it overrides the root value for iOS only (same precedence as on Android). The SDK checks push notification authorization status (Apple documentation) and only tracks the push token if the user is authorized. When disabled, the SDK registers for push on app start and tracks the token (e.g. for silent push). Unless you're only using silent notifications, keep the 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.

Updated 2 days ago