Sending Domains, Tracking Domains and Deep Links

To send email with Iterable, you'll need to set up senders, sending domains, and tracking domains. Additionally, you'll need to configure the destination domains and paths (as specified by apple-app-site-association files) that each of your tracking domains will rewrite as deep links. This guide describes how to do all of these things.

# Table of contents

# Overview

The following few sections describe how Iterable works with email service providers, sending domains, senders, tracking domains, deep links, destination domains, apple-app-site-association files, and assetlinks.json files.

# Email service providers (ESPs)

To send email, Iterable projects by default use Amazon SES with a shared IP address. However, it's also possible to use other ESPs (for example, Sparkpost or SendGrid).

# Definitions

This guide describes the following things:

• Sending Domains - The domains from which your Iterable project can send email.

  When using Amazon SES with a shared IP address, a project can have only one sending domain, defined on the Settings > Project Settings screen or based on the web site associated with your Iterable organization.

  For other ESP configurations, you can define multiple sending domains on the Settings > Mail Domains screen.

• Senders - Verified email addresses from which your Iterable project can send email.

  When using Amazon SES with a shared IP address, each sender should align with the sending domain defined in your Iterable project's settings or the web site associated with your Iterable organization—whichever defines your sending domain.

  For other ESP configurations, each sender should align with one of the sending domains defined on the Settings > Mail Domains screen.

• Tracking Domains - Also called link tracking domains. The domains Iterable uses when rewriting links in the emails your project sends. They enable click tracking and attribution, and they should align with your sending domains.

  For example, consider a project with a sending domain of example.com. A tracking domain that aligns with this sendign domain would be links.example.com.

  If this same project sends an email that includes a link to https://example.com/products/123, recipients will receive that link in its rewritten form (something like http://links.example.com/u/click?_t=7dd208...). After a reader clicks the link, the tracking domain tracks it and redirects to the original link destination (in this case https://example.com/products/123).

  A link's rewritten URL can be seen when readers click on, hover over or copy the link. Because of this, it's a good idea to clearly associate the tracking domain with the email's sending domain.

  NOTE

  To enable a custom link tracking domain, you'll need to configure your site's DNS to point it to links.iterable.com (Iterable's server that does the link tracking for all projects), as described below.

• Deep Links - Links that open, when tapped on a mobile device, directly in your app if it's installed—and a web browser otherwise. Iterable rewrites standard links and deep links to point to your link tracking domain. Rewritten URLs for standard links include /u/ and rewritten URLs for deep links include /a/. Your mobile apps can be configued to expect these /a/ links (as associated with your particular link tracking domains), and to open them without a browser.

  IMPORTANT

  To use Iterable to send deep links, you must set up a custom, HTTPS-enabled tracking domain.

• Destination Domains - For a particular tracking domain, specify the domains for which Iterable should rewrite links as deep links by configuring destination domains. Then provide an apple-app-site-association file to describe the specific paths that should be rewritten for each destination domain. For more information, see below.

# How do the pieces fit together?

Iterable senders, sending domains, tracking domains and destination domains are related. When sending an email campaign:

• You'll select one of your project's senders.

• Iterable uses the selected sender to determine the campaign's sending domain.

• Each sending domain is associated with a single tracking domain. Iterable uses that tracking domain to rewrite your campaign's links and then tracks those links when they're clicked.

  NOTE

  Additionally, the linking tracking domain can set attribution cookies in the recipient's browser. These cookies can help your server understand which campaign and template caused the click, and it can use this information to attribute a purchase or conversion event to a specific marketing effort.

• The selected tracking domain also determines which email links Iterable will rewrite as deep links (for email campaigns). The destination domains defined for a particular tracking domain determine the domains for which Iterable will rewrite links as deep links. The apple-app-site-association file for each destination domain defines the relevant paths.

# Permisions

To work with the items described in this guide, you'll need the Channel Configuration > View (to view) or Channel Configuration > Manage (to edit) permission.

# Setting up your ESP

The following sections describe how to set up your ESP, whether Amazon SES with a shared IP (the default) or another ESP.

# Amazon SES with a shared IP address (default configuration)

If you're using Amazon SES with a shared IP address (Iterable's default ESP configuration), follow these instructions to configure your project to send email:

1. Specify your project's sending domain. When using Amazon SES with a shared IP address, an Iterable project can only have one sending domain. To specify it, navigate to Settings > Project Settings and enter it in the Custom Project Sending Domain input.

   

   NOTES

   • If you don't provide a Custom Project Sending Domain, Iterable uses the domain associated with your organization's configured web site.
   • When using Amazon SES with a shared IP address, there's no need to specify a sending domain on the Settings > Mail Domains screen.

2. To enable your sending and link tracking domain, configure your site's DNS. To do this, navigate to Settings > DNS Setup, copy the DNS records and work with your site administrator to add them to your site's configuration.

   

   IMPORTANT

   The DNS records shown on the Settings > DNS Setup screen are valid only when using Amazon SES with a shared IP address. When using other ESPs, ignore this screen.

3. Add senders to your project, each of which should have a domain that matches the sending domain defined in step 1, above. To do this, navigate to Settings > Senders, click Create New Sender and specify their information.

   

   If you've configured your DNS (as described in the previous step), Iterable should display the new sender as Verified. Otherwise, Amazon will send you a verification email for new senders. After you respond, Iterable will mark the sender as verified.

4. Create a custom tracking domain that Iterable can use to rewrite links in the emails your project sends (for more information, read this guide's Overview).

   TIP

   If you don't want to use a custom tracking domain, you can skip this step, and Iterable will rewrite links in email campaigns as http://links.iterable.com/.... Remember, however, that this URL is visible to your recipients when they click on, hover over or copy a link. They won't expect to see an iterable.com URL, so it's best to provide a custom tracking domain.

   

   To do this:

   • Navigate to Settings > Mail Domains and click New Tracking Domain.

   • For the tracking domain, enter links.<YOUR_SENDING_DOMAIN>. For example, if your sending domain is example.com, your tracking domain would be links.example.com (which matches the CNAME record configured for your site's DNS in step 2, above).

   • To set the new tracking domain as your project's default, click the down on its table row and choose Set as Default.

   • If your website is HSTS compliant, or if you will be sending deep links that should be opened by a mobile app, enable HTTPS for your tracking domain. After you do this, click your tracking button's Edit button and turn on the Enable HTTPS toggle.

   • Allow 24 hours for Iterable to verify the tracking domain.

# Other ESPs (Sparkpost, Sendgrid, etc.)

If you'd like to use an ESP other than Amazon SES with a shared IP address, work with your customer success manager to configure your ESP and your Iterable project. You'll need to set up:

• Your ESP configuration.

• Your site's DNS. In particular, your DNS will need to map custom link tracking domains (for example, links.example.com) to links.iterable.com (Iterable's server that actually performs the click tracking and redirection).

  IMPORTANT

  The DNS records shown on the Settings > DNS Setup screen are valid only when using Amazon SES with a shared IP address. When using other ESPs, ignore this screen.

• Tracking domains (on the Settings > Mail Domains screen). Set up HTTPS for these tracking domains as necessary (mandatory if you need to send deep links).

• Senders (on Iterable's Settings > Senders screen).

• Sending domains (on the Settings > Mail Domains screen). Make sure to verify the domain and select a tracking domain.

# Deep links

Deep links, when tapped on a mobile device, open directly in your mobile app if it's installed, and in a web browser otherwise. To configure Iterable so that it can send deep links for your project, follow these steps:

# 1. Set up a custom tracking domain and enable HTTPS

To enable deep linking, you'll need an HTTPS-enabled custom link tracking domain, rather than Iterable's default link tracking domain (http://links.iterable.com). There are a few reasons for this:

• Apple requires that iOS apps pull apple-app-site-association files from an HTTPS-enabled endpoint, without redirects. Since Iterable hosts this file for your app, (as configured by your site's DNS), you'll need to enable HTTPS.

• Android requires that assetlinks.json files are served with HTTPS. Since Iterable hosts this file for your app, (as configured by your site's DNS), you'll need to enable HTTPS.

• Iterable hosts each tracking domain's aggregate apple-app-site-association file at https://<YOUR_TRACKING_DOMAIN>/apple-app-site-association, and assetlinks.json file at https://<YOUR_TRACKING_DOMAIN>/.well-known/assetlinks.json. It is not possible for Iterable's default tracking domain (http://links.iterable.com) to host these files for all the various Iterable projects that use it as a tracking domain.

# 2. Decide which links your mobile apps should open

Determine the precise link patterns your mobile app should open. Once you've made this decision, build apple-app-site-association and assetlinks.json files (if you don't already have them).

For more information, see Iterable's iOS Universal Links and Android App Links guides

# 3. Configure your mobile apps to support deep links

To enable deep links in your mobile apps, follow these instructions:

• Configure your iOS app to support Universal Links (the iOS implementation of deep links).
• Configure your Android App to support App Links (the Android imlementation of deep links).

# 4. Set up destination domains and paths in Iterable

Destination domains and their paths make it possible to specify that an app should open some links—but not others—for a particular tracking domain.

For each of your tracking domains, you can define multiple destination domains. Iterable uses these destination domains, along with the the paths listed in their associated apple-app-site-association files, to determine which links to rewrite as deep links.

For example, consider a project that has the following setup:

• A links.example.com tracking domain
• A support.example.com destination domain for that tracking domain
• An associated apple-app-site-association file that specifies /product/* as a path

Now, assume that this project sends an email that contains a link to https://support.example.com/product/widget, from a sender whose sending domain is associated with the links.example.com tracking domain mentioned above.

Since this link URL matches the destination domain (support.example.com) and path (/product/widget matches /product/*), Iterable will rewrite the link as a deep link before sending it.

On the other hand, a link to https://support.example.com/news/today will not be rewritten as a deep link. The destination domain matches the URL, but the apple-app-site-association file has no match for the path.

To set up destination domains and their paths:

1. Navigate to Settings > Mail Domains.

2. On the tracking domain you'd like to configure, click Edit.

   

3. On the Tracking Domain screen, click New Destination Domain.

   

4. Specify the destination domain for which you'd like your app to open at least some links, and click Create.

5. The destination domain will now be listed in the table. To modify it, click its Edit button.

6. On the Destination Domain screen, use the Edit Configuration buttons to upload the apple-app-site-association and assetlinks.json files you created above. After uploading the files, click Save Changes in each section.

   

   IMPORTANT

   • Each tracking domain has a single assetlinks.json file. Uploading an assetlinks.json file for any of that tracking domain's destination domains overwrites it for all of that tracking domain's destination domains.
   • Upload standard apple-app-site-association files. Iterable previously required apple-app-site-association files that contained an iterable section, and which explicitly called out the /a/ path which Iterable uses to denote deep links. However, this is no longer required. The legacy file format still works, but will cause Iterable to rewrite links that contain /a/ as deep links.

• To enable or disable a particular destination domain for a tracking domain, navigate to the Tracking Domain screen for the tracking domain in question, click the down arrow next to the destination domain in question, and choose Enable or Disable. :::

# 5. Test your deep link configuration

To test your deep link configuration, follow these steps:

1. Check to make sure that Iterable exposes your tracking domain's aggregate apple-app-site-association file at https://<YOUR_TRACKING_DOMAIN>/apple-app-site-association. This file is a combination of all the apple-app-site-association files uploaded to destination domains associated with the relevant tracking domain.

2. Check to make sure that Iterable exposes your assetlinks.json file at https://<YOUR_TRACKING_DOMAIN>/.well-known/assetlinks.json.

3. Send an email campaign to yourself, from a sender who's ultimately associated with the tracking domain to which you just added a destination domain.

   In the email, include test links—some that should be rewritten as normal links (which include /u/ after Iterable rewrites them), and some that should be rewritten as deep links (which include /a/ after Iterable rewrites them).

4. When you receive the message, inspect the link URLs to make sure that they've been rewritten as you expect.

5. Test opening these same links in your mobile app, to ensure that the app responds as you expect.

# Deep link configuration enhancements: migration instructions

The deep linking configuration enhancements release introduced various changes to the configuration of deep links in Iterable. These changes make it possible to:

• Define the specific domains and paths that Iterable will (and will not) rewrite as deep links for a given tracking domain (by defining destination domains and giving each one an apple-app-site-association file). This allows you to decide on the subdomains for which a tracking domain should rewrite links as deep links.

• Upload and manage apple-app-site-association and assetlinks.json files directly in Iterable, without contacting your customer success manager.

# Before the configuration enhancements release

Before the configuration enhancements release, the tracking domain associated with an email campaign's sender caused Iterable to rewrite as deep links all links that shared a root domain with that tracking domain (assuming deep links were enabled for the project).

For example, a tracking domain of links.example.com caused Iterable to rewrite links to support.example.com, docs.example.com and app.example.com all as deep links.

# After the configuration enhancements release

After the configuration enhancments release, this same behavior remains in effect for tracking domains already configured to send deep links. On the Settings > Mail Domains screen, Iterable marks these tracking domains as Legacy, and they continue to rewrite deep links for all links that point to the tracking domain's root domain, using your existing apple-app-site-association file.

However, once you manually add a new destination domain to a legacy tracking domain, Iterable no longer respects the original configuration. At that point, you'll need to define a destination domain for each domain or subdomain for which you'd like Iterable to rewrite deep links, and upload an apple-app-site-association file for each (to define the specific paths for that domain or subdomain for which links should be rewritten as deep links).

For example, to configure tracking domain links.example.com to rewrite deep links for in-email links that point to support.example.com, docs.example.com or app.example.com, you'll need to add three destination domains to that tracking domain.

# Viewing deep link files

The configuration enhancements release removes the the apple-app-site-association and assetlinks.json files from the Settings > Project Settings screen. To view the Iterable-hosted versions of these files, navigate to:

• https://<YOUR_TRACKING_DOMAIN>/apple-app-site-association
• https://<YOUR_TRACKING_DOMAIN>/.well-known/assetlinks.json

# Further reading

• How to Set Up HTTPS for Link Click Tracking
• Iterable's Deep Links guides
• Apple's Universal Links documentation
• Android's App Links documentation