Skip to content
Get Help

Email Integration Guide

This guide covers how to configure and test Branch Email in your dashboard and ESP.

Before you begin ​

Branch Email requires technical prerequisites to be completed by your development team before you can configure the integration.

Your developers must implement the Branch SDK, enable Universal Links, configure Associated Domains, and set up deep link routing in your app.

See our developer documentation for implementation details.

Enable the integration ​

To enable the integration:

  1. In the left-hand navigation, click Email.
  2. On the Email overview page, click the Manager tab at the top.
  3. Find your ESP and click Enable.

Note

Branch automatically detects any global link settings you have already provided during the initial setup of your Branch account as outlined above.

If you have not set up your global link settings and redirect preferences, you will be prompted to do so at this time.

Disable third-party click tracking ​

Many third-party providers add redirects to your URLs. This facilitates click tracking and analytics on those platforms, but will break Universal Link and App Link functionality. To make Universal Links and App Links work, you will need to disable click tracking in the third-party system. Here are instructions for some common platforms:

Provide click tracking domain ​

Click tracking domains allow you to track engagement on email opens and link clicks.

If you're unsure what your click tracking domain (CTD) is, take a look at one of your recently sent emails. If you hover over the link or right-click/copy the link address, you will see that the domain of the link in the email does not match the URL in your HTML. This domain is your click tracking domain used by your ESP to provide you click reporting.

Alternatively, use the button below to find your ESP's documentation on how to find your click tracking domain. If no documentation is available, we provide a link on how to contact the support team for your ESP.

Caution

Leave off http:// and https:// when adding your click tracking domain in the Branch Dashboard.

Caution

Before you click NEXT and proceed to the Validate & Test section, please complete the DNS CNAME configuration step, as it's required for passing integration validation. Your development or IT team will need to configure DNS settings.

Expand for ESP CTD list

Important considerations ​

  • You can enable the integration with multiple CTD if needed, but you cannot add the same CTD to multiple Branch dashboards or ESP integrations.

  • Some ESPs are single-tenant. Each customer has their own tracking server instead of a shared one. For these ESPs, the setup page also asks for your server's domain in a field named for the ESP, such as Emarsys domain. Branch uses it to pass each click on to your ESP.

    • Get this domain from your ESP account manager.
    • If the field doesn't appear, your ESP uses a shared server and you don't need to add anything.
  • In some ESP integrations, you will also be required to send them the AASA file Branch generates by providing your ESP's contact email.

    • The ESP selected will dictate whether this field appears or not - if the field does not appear, you're not required to add it.

DNS CNAME configuration ​

Caution

If you ever remove your click tracking domain from Branch or disable the email integration, you must also delete the corresponding CNAME record from your DNS configuration. Leaving a CNAME record pointing to Branch after the domain has been removed from your Branch account creates a dangling DNS entry that could be claimed by an unauthorized party, posing a subdomain takeover security risk.

Most ESP integrations require updating the DNS record for your click tracking domain to include a CNAME record that points to Branch's domain. Your development or IT team will need to complete this step. See our developer documentation for implementation details.

Test the integration ​

Once the validation process is complete, you can test the integration by generating a test link. The test link generated by Branch is unique in that it's already converted to a Branch Link for you and allows you to test without creating an email template in your ESP. In reality, this conversion happens behind the scenes once a user clicks on your normal email template link.

To generate a test link:

  1. In the Validate & Test section, input a URL from your website.

  2. Click Get Test Link.

  3. Once the test link is generated, you can share it via:

    1. Copy to clipboard

    2. SMS

    3. Email

Once you've generated your test link, click the link on your mobile device.

Tip

Make sure your mobile device already has the app installed!

Before you start setting up your email campaigns, you need to determine what flow you want the user to experience and flag your email link accordingly.

Most ESPs support the following user flows:

  • Deep linking users to in-app content

    • Added to your links as a URL query parameter:
      <a href="links.example.com?$deep_link=true" >Link to your app!</a>
    • Added to the HTML:
      <a href="http://example.com" deeplink="true">Link to your app!</a>
  • Linking users to web-only content

    • Added to your links as a URL query parameter:
      <a href="links.example.com?$web_only=true" >Link to your app!</a>

FAQs ​

How can I request a new Email partner?

Have your Email Service Provider (ESP) Account Manager fill out the Branch Partner Profile form.

How can I send additional data to my ESP?

Branch's Branch Email integration will automatically send click tracking analytics to ESPs. Some ESPs have formal data integrations with Branch to send additional data like installs.

Please refer to Branch's Data Integrations Partner List to see if your ESP supports this.

Do I need to renew the SSL certificate for my click tracking domain?

No. Once your CNAME points to Branch, Branch issues the SSL certificate for your click tracking domain and renews it automatically before it expires. You don't need to do anything, and you don't need to change your CNAME or any other DNS record to trigger a renewal.

Don't remove or change the CNAME record to force a renewal. Doing so breaks the integration. Until the record points back to Branch and the certificate is issued again, which can take up to an hour, clicks on that domain redirect to your account's default URL instead of the intended destination.

If Branch Support set up your certificate manually, ask Support how renewal works for your domain.