This guide will walk you through how to integrate your email service provider with Branch. If you have not completed the getting started steps, please follow this documentation first.
Configure your ESP¶
To open the app directly on iOS 9.2+, you must configure your email integration and your app to support Universal Links in emails.
Tell us your click tracking domain¶
You can retrieve your click tracking domains from your Sendgrid settings:
- Log in to your SendGrid account.
- Go to Settings > Whitelabels > Email Links.
Find your email link whitelabeled domain, click on the gear icon and click "View" (or create a new whitelabel).
Note the "Host" email click tracking domain (e.g. email.mydomain.com) and the SendGrid domain under "Data".
Enter both the click tracking domain and the SendGrid domain in item 1 of this step:
On Done click, an AASA file - required for Universal Links - specific to that domain will be generated.
Configure your app for your click tracking domain¶
In this prompt, enter the email of someone on your team who is qualified to modify your iOS app, and then click Send. They will complete the technical setup steps below.
The following app changes ensure that your email integration supports Universal Links. You will need access to your app code to make these changes.
How does it work?
Apple recognizes the click tracking domain as a Universal Link, and opens the app immediately without the browser opening. Once the app has opened, Branch will collect the referring URL that opened the app (at this time, it will be the click tracking url). Inside the app, Branch will robotically “click” the link, registering the click with the ESP, and returning the Branch link information to the Branch SDK inside the app. This information is then used to deep link the user to the correct in-app content. See the Support section for more information.
Validate your click tracking domain in SendGrid¶
Before you CNAME to Branch, you must CNAME your click tracking domain to sendgrid.net and validate the domain in Whitelabel > Email Links within SendGrid. Once there is a green checkmark indicating that the domain is valid, then you can proceed to the next step.
Set up your click tracking domain¶
Create a CNAME for your click tracking domain and point it to
Add your click tracking domain to your Associated Domains¶
To enable Universal Links on your click tracking domain, you'll need to add the click tracking domain to your Associated Domains entitlement.
- In Xcode, go to the
Capabilitiestab of your project file.
Scroll down and enable
Associated Domainsif it is not already enabled.
Copy your click tracking domain from the email you received from Branch, or retrieve it from your ESP's settings.
Domainssection, click the
+icon and add your click tracking domain. For example, if your click tracking domain is
email.example.com, add an entry for
Having trouble or new to Universal Links?
Follow these instructions for more details on enabling Universal Links in the Branch dashboard and in Xcode.
Validate and test¶
The last step of the Deep Linked Email setup flow validates whether you have completed all necessary steps and whether an engineer on your team has completed the technical setup steps. You will also see recommendations for how to improve your email integration.
Once you’ve completed the one time setup steps, it’s time to send your first email.
This guide will identify which web links you'd like to open the app and deep link, as well as convert them to Branch links.
Flag your deep links¶
In order for your email service provider to know that the email link should open the app, add
universal="true" to the HTML, for example:
<a href="http://example.com" universal="true">Link to your app!</a>
This will also ensure that your links are converted to Branch links that will open the app on Android as well, with full tracking and attribution.
What happens to your links behind the scenes?
This is what a link looks like within your email template:
When a user clicks your link, Branch processes the link and converts it to something like this:
vza3.app.link is your Branch domain.
The conversion to Branch links will only work when your links are wrapped in your click tracking domain. To test links without wrapping, please generate a test link on step 3 of email onboarding, also accessible by clicking the gear icon for your ESP on the email page.
Curious about how email works and more FAQ? Visit our general email support page.