Skip to main content
The React Native SDK supports iOS as well as Android. On iOS you get configure, handleLink, onDeepLinkResolved, and onDeepLinkFailed. To open your app from DeepLink links on iOS, configure Associated Domains (Universal Links).

​
Associated Domains entitlement

  1. In Xcode, select your app target and open Signing & Capabilities.
  2. Click + Capability and add Associated Domains.
  3. Add your DeepLink domain in this form:
    • applinks:your-domain.com
      Replace your-domain.com with the host you use in the DeepLink dashboard (e.g. your app’s subdomain).
In the project, this is stored in ios/YourApp/YourApp.entitlements (or your custom entitlements file): 
<key>com.apple.developer.associated-domains</key>
<array>
  <string>applinks:your-domain.com</string>
</array>

​
Apple App Site Association (AASA)

DeepLink can host the required Apple App Site Association (AASA) file on your link domain once you configure your app’s bundle ID and Apple Team ID in the dashboard. You don’t need to create or host this file yourself. In your React Native app, call configure({ apiKey }) as in Installation. Use Linking.getInitialURL() and Linking.addEventListener('url', ...) to get the URL, then pass it to handleLink(url). Subscribe to onDeepLinkResolved and onDeepLinkFailed as in Handling links. The same JavaScript code works on both iOS and Android.

​
Test on device

Universal Links often do not work in the simulator. Test on a real device to confirm links open your app and that handleLink and the events fire as expected.

​
Next steps

  • Handling links — Pass URLs to the SDK and subscribe to resolved/failed events.