🌱Branch.io
Set up Branch.io deep linking in your Natively app for reliable cross-platform deep links with attribution and analytics.
What is Branch.io
Branch.io is a third-party deep linking platform that guarantees reliable navigation to your app, even if the app is not installed, by directing users to the appropriate app store. On top of standard deep linking, Branch provides link performance tracking, user journey optimization, and marketing attribution, making it a good choice for apps with active marketing campaigns.
If you only need basic deep linking without attribution or analytics, consider using Universal Links instead, since they require no third-party service.
Prerequisites
A Branch.io account.
Branch.io setup
Once your Branch.io account is created, you'll be directed to configure your app's default link behaviors. Follow the steps below to complete the setup.
Default URL
Go to App Settings in the sidebar.
Default URL: Insert your app's URL.
Configure Android redirects
Check I have an Android App.
Enter your Android URI Scheme - your app's Bundle ID in lowercase, followed by
://. For example:com.example.natively://.Select your app's store listing:
If your app is already published: select Google Play Search and find your app.
If your app is not yet published: select Custom URL, then enter your app's URL and Bundle ID.
Check the box Enable App Links and enter your SHA256 certificate fingerprints, as a comma-separated list.
Your SHA256 certificate fingerprints can be found in Google Play Console under Protected With Play > Play Store protection > Protect app signing key > Manage Play App Signing.
If you don't see the Upload key certificate content, you need to upload your app first.
Configure iOS redirects
Check I have an iOS App.
Enter your iOS URI Scheme - your app's Bundle ID in lowercase, followed by
://. For example:com.example.natively://.Select your app's store listing:
If your app is already published: select Apple Store Search and find your app.
If your app is not yet published: select Custom URL, then enter your app's URL and App Store App ID.
Check Enable Universal Links and enter the following:
Bundle Identifier - your app's Bundle ID.
Apple App Prefix - open your Apple Developer account > Identifiers, select your app's Bundle ID, and copy the App ID Prefix shown at the top of the identifier details page.
Check Enable NativeLink and set Audience Rule to All iOS traffic.
Link Domain
Set up a subdomain or your own custom domain.
Enter your Default Link Domain (e.g.
yourdomain.app.link).Enter your Alternate Link Domain (e.g.
yourdomain-alternate.app.link).Click Save.
Natively Dashboard setup
Go to Branch.io Account Settings and copy the Branch Key.
Open your Natively app's dashboard and navigate to Features > Deep Links > Branch.
Toggle the feature to Enabled.
Enter the Default Link Domain from the Link Domain step above in the Domain field.
Enter the Alternate Link Domain from the Link Domain step above in the Alt Domain field.
Enter the Branch Key in the Key field.
Click Save.
Rebuild your app(s).
You must rebuild your app for these changes to take effect.
How to use
Once Branch.io is configured and your app is rebuilt, you can start creating deep links. A Branch deep link follows this format:
{default_link_domain}/?$deeplink_path={url}
Example:
https://yourdomain.app.link/?$deeplink_path=https://yourdomain.io/test/reset_pw?test
To create and manage your deep links, use the Branch.io Dashboard.
Troubleshooting
Deep links are not opening the app
Make sure the URI scheme, Bundle ID, and SHA256 fingerprints are correctly configured in the Branch.io dashboard. Verify that your app has been rebuilt after saving the Natively Dashboard configuration.
Google Play Data Safety section rejection
Developers are required to fill out Google's updated Data Safety section in the Google Play Console when using Branch.io. Without approval in the Data Safety section, your new app submission or app update may be rejected.
For detailed information on completing the Google Play Store questions: Answering the Google Play Store Privacy Questions.
Branch Key not working
Make sure you are using the correct Branch Key from your Branch.io Account Settings. Verify that the Default and Alternate Link Domains match exactly what is configured in Branch.io.
Last updated