Iterable's React Native SDK

Iterable is a growth marketing platform that helps you to create better experiences for—and deeper relationships with—your customers. Use it to send customized email, SMS, push notification, in-app message and web push notification campaigns to your customers.

This SDK helps you integrate your React Native-based iOS and Android apps with Iterable. It supports JavaScript and TypeScript.

• Iterable's React Native SDK
  • Requirements
  • Installation
  • 📚 API Documentation
  • Architecture Support
  • Beta Versions
  • Features
  • Example project
  • Building a local npm package
  • Version mapping
  • Release notes, support and troubleshooting
  • License
  • Want to contribute?

Requirements

Iterable's React Native SDK relies on:

• React Native

  • React Native 0.75+
  • React 18.1+

  UI Components require additional peer dependencies

  • React Navigation 6+
  • React Native Safe Area Context 4+
  • React Native WebView 13+

• iOS

  • Xcode 12+
  • Deployment target 13.4+
  • Iterable's iOS SDK
  • Podfile Configuration: The linkage must be set to dynamic in your Podfile to load Swift modules that the SDK depends on. Add the following to your Podfile:

    use_frameworks! :linkage => :dynamic
    Copy

  • Xcode 27: run-ios needs @react-native-community/cli 20.2.0+ so it opens Device Hub (DeviceHub.app) instead of Simulator.app. xcode-select must point at the Xcode you are using when more than one version is installed. Xcode 27 also refuses CocoaPods resource-bundle targets below iOS 15.0 (this SDK's IterableSDKResources bundle still inherits 12.0 from Iterable-iOS-SDK, including 6.7.5 pinned by RN 3.2.0). Lift generated Pods targets to 15.1 in the app Podfile post_install — see this repo's example/ios/Podfile. That is a host workaround until Iterable's iOS SDK publishes a ≥ 15.1 minimum and this SDK depends on it. It does not change the published Iterable iOS support range.

• Android

  • minSdkVersion 21+, compileSdkVersion 31+
  • Iterable's Android SDK

Installation

For installation instructions, read Installing Iterable's React Native SDK.

📚 API Documentation

View the API documentation.

Architecture Support

Iterable's React Native SDK supports React Native's New Architecture, including TurboModules and Fabric.

IMPORTANT: Iterable's React Native SDK supports React Native's Legacy Architecture, but it is no longer actively maintained. Use at your own risk.

Notes:

• Ensure your app is configured for New Architecture per the React Native docs.
• The example app in this repository is configured with New Architecture enabled.

Beta Versions

To opt into beta versions of the SDK, you can install the latest beta version by using the beta tag:

# Install the latest beta version
npm install @iterable/react-native-sdk@beta

# Or using yarn
yarn add @iterable/react-native-sdk@beta
Copy

Note: Beta versions may contain experimental features and could have breaking changes. We recommend testing beta versions in development environments before using them in production. Please report any issues found in beta releases to Customer Support.

Features

To learn more about the SDK, read:

• Overview of Iterable's React Native SDK
• Installing Iterable's React Native SDK
• Managing User Identity
• User Profile Data and Subscription Preferences
• Tracking Events
• Deep Links and Custom Actions
• Push Notifications
• In-App Messages
• Migrating to Iterable's React Native SDK

Example project

For sample code, take a look at the following project:

• Example App

Building a local npm package

Generate a .tgz from this React Native SDK checkout. Do not run npm pack from a consuming app; that will not produce @iterable/react-native-sdk.

From the root of this repository:

yarn install
npm pack
Copy

yarn install runs prepare / yarn build. npm pack writes iterable-react-native-sdk-<version>.tgz in the repo root, using the version in package.json (for example iterable-react-native-sdk-3.2.0.tgz).

Version mapping

For quick reference, the following table lists the versions of the Android SDK and the iOS SDK the React Native SDK points to for version 1.2.0 and above.

RN SDK Version	Android SDK Version	iOS SDK Version
3.2.0	3.10.1	6.7.5
3.1.0	3.6.2	6.6.7
3.0.1	3.6.2	6.6.3
3.0.0	3.6.2	6.6.3
2.2.2	3.6.2	6.6.3
2.2.1	3.6.2	6.6.3
2.2.0	3.6.2	6.6.3
2.1.0	3.5.2	6.5.4
2.0.4	3.5.2	6.5.4
2.0.3	3.5.2	6.5.4
2.0.2	3.5.2	6.5.4
2.0.1	3.5.2	6.5.4
2.0.0	3.5.2	6.5.4
1.3.21	3.5.2	6.5.4
1.3.20	3.5.2	6.5.4
1.3.19	3.5.2	6.5.3
1.3.18	3.5.2	6.5.3
1.3.17	3.4.16	6.4.15
1.3.16	3.4.15	6.4.15
1.3.15	3.4.14	6.4.14
1.3.14	3.4.13	6.4.14
1.3.13	3.4.11	6.4.12
1.3.12	3.4.10	6.4.12
1.3.11	3.4.10	6.4.11
1.3.10	3.4.10	6.4.10
1.3.9	3.4.10	6.4.9
1.3.7	3.4.10	6.4.8
1.3.6	3.4.9	6.4.7
1.3.5	3.4.9	6.4.7
1.3.4	3.4.8	6.4.6
1.3.3	3.4.7	6.4.5
1.3.2	3.4.5	6.4.3
1.3.1	3.4.5	6.4.2
1.3.0	3.4.5	6.4.2
1.2.3	3.4.5	6.4.2
1.2.2	3.4.4	6.4.1
1.2.1	3.4.3	6.4.1
1.2.0	3.4.3	6.4.1
1.1.3	3.3.8	6.3.4
1.1.2	3.3.5	6.3.3
1.1.1	3.3.4	6.3.2
1.1.0	3.3.2	6.3.1

Release notes, support and troubleshooting

Release notes:

• Release Notes - Iterable's React Native SDK (major releases)
• Releases page on GitHub on GitHub (minor releases)

Support policies:

• Iterable's Mobile SDK Support Policy
• Deprecation and End-of-Life Schedule for Iterable's React Native SDK

Please contact your customer success manager with any questions.

License

This SDK is released under the MIT License. See LICENSE for more information.

Want to contribute?

This library is open source, and we will look at issue reports and pull requests. See CONTRIBUTING for more information.