We constantly publish updates to our documentation, which may not yet be available in your language. For the most current information, use the English version.
You need to retrieve the following data points before you can set up deep links in your app:
App ID prefix: A 10 character identifier found at the beginning of your App ID. You can find your App ID prefix in the Apple developer portal. Example: ABC1234567
Release Bundle ID: Your app's unique identifier. Example: com.example.app.
Debug Bundle ID: The bundle ID of your debug build. Only required if this is different from your release bundle ID and you need to test deep linking before release.
Release Custom URL Scheme: A custom URL that opens resources in your app. This is required for linking from certain applications on the device, such as Telegram, Twitter, and YouTube, or from push notifications. Example: exampleApp://.
Debug Custom URL Scheme: Required if your debug Custom URL scheme is different from your release Custom URL scheme and you need to test deep linking before release.
Link resolution domain(s): Required for deep linking via email, SMS, QR codes, and platforms that shorten links. Example: email.example.com.
Select Certificates, IDs & Profiles from the left-hand menu.
Select Identifiers from the left-hand menu.
Find your app and select it to open the edit page.
Your App ID Prefix and Bundle ID are displayed at the top of the page. Copy the relevant information and store it somewhere for later use.
Debug Bundle ID
If you are using a different bundle ID for your debug build, you can find its ID in Xcode.
Open your app project in Xcode.
Select your project from the left-hand menu.
Select your app under Targets.
Select Signing & Capabilities from the top menu.
Select Debug from the sub menu that appears.
Your Bundle ID is shown. Copy this information and store it somewhere for later use.
Release Custom URL Scheme and Debug Custom URL Scheme
Tip:
A custom URL scheme is required for linking from certain applications on the device, such as Telegram, Twitter, and YouTube, or from push notifications. Check with your marketing team to see if a custom URL scheme is needed for the app. It is highly recommend to use the same custom URL scheme for iOS and Android.
To retrieve your Custom URL Scheme, follow these steps:
Open your app project in Xcode.
Select your project from the left-hand menu.
Select your app under Targets.
Select Info from the top menu.
Expand the URL Types section and get the custom URL scheme. If the URL Schemes field contains a build setting (for example: $(CUSTOM_URL_SCHEME)), go to the build settings to retrieve the custom URL scheme values:
Select Build Settings from the menu at the top.
Find the setting named in the URL Schemes field and retrieve both the release and debug values.
If your iOS app does not yet have a custom URL scheme, follow these steps to set a custom URL scheme:
Open your app project in Xcode.
Select your project from the left-hand menu.
Select your app under Targets.
Select Info from the top menu.
Expand the URL Types section.
Select the Add option (+) to add a new URL type.
Fill in the following information to create a URL scheme:
Identifier: $(PRODUCT_BUNDLE_IDENTIFIER)
URL Schemes: your custom URL scheme. This must be unique. Don't use protected schemes such as http, https, or mailto
Role: Editor
This scheme will work for your production and debug builds.
Link Resolution domains
Tip:
A link resolution domain is required for deep linking via email, SMS, QR codes, and platforms that shorten links. Check with your marketing team to see if link resolution is needed for the app.
Your marketing team may already be using a link resolution domain for their email marketing platform. Get this domain from them and store it somewhere for later use.