Skip to main content
The DeepLink React Native SDK (deeplink-rn) provides install attribution and deep link tracking for React Native apps on Android and iOS. Add the package, rebuild, then configure with your API key.

​
Add the package

From your React Native project root: 
npm install deeplink-rn
# or
yarn add deeplink-rn
For local development (SDK in a sibling folder): 
npm install ../deeplink-rn
# or
yarn add ../deeplink-rn
Then rebuild the native app so the native module is linked: 
npx react-native run-android
Note: The native module is named InstallAttribution. If you skip the rebuild, you’ll see: “Native module not found. Did you rebuild the app after installing the package?”

​
Minimum requirements

  • React Native 0.60 or higher
  • Android: minSdkVersion 21+ (for install referrer and app links)

​
Configure the SDK

Call configure once at app startup, after the root component is mounted (so an Activity is available): 
// e.g. in index.js or App.js
import { configure } from 'deeplink-rn';

configure({
  apiKey: 'YOUR_API_KEY_HERE',  // required – from the DeepLink dashboard
  // endpoint: 'https://your-api.example.com',  // optional – override base URL
});
  • apiKey (string, required)
  • endpoint (string, optional)
The SDK will track the install referrer, send an initial app-open event, and process any launch deep link from the Activity intent.

​
Next steps

Configure each platform and then handle incoming links:

Android setup

App Links and intent filters.

iOS setup

Current support and limitations.
After setup, see Handling links to pass deep link URLs to the SDK and subscribe to resolved/failed events.