Journeys & iOS Safari Banner Compatibility

If you have iOS Universal Links enabled on your main domain, you should see Apple's Smart App Banners along with your Journeys banner. This can lead to customer confusion on which call to action to interact with to get to your mobile app.

In order to maximize conversion while maintaining full compatibility of Journeys and Universal Links, we recommend utilizing a Floating Pill Button for your Journeys campaign.

Journeys Website Redirect Options

You can configure your Journeys banner to redirect users to a website by doing the following:

Configure Your Redirect Keys

• $android_url - Controls where the journey sends Android users who do not have the app installed; otherwise, the user will be deep linked into the app if installed.
• $ios_url - Controls where the journey sends iOS users who do not have the app installed; otherwise, the user will be deep linked into the app if installed.
• $fallback_url - Controls where the journey sends users who do not have the app installed; otherwise, the user will be deep linked into the app if installed.
• $journeys_cta - Controls where the journey link will redirect to.
  • User is redirected to the provided location regardless of whether or not they have the app installed.
    • For example, redirect all Journeys clicks to mobile web OR deep link users to a different app for cross-promotion.
  • This key overrides all others.
  • NOTE: Removes the ability to track Journeys click-through rates, as the customer’s link will be used for the CTA. Branch will not get clicks, and thus it will not be able to attribute installs, opens, or conversion events.

Setup via Dashboard

When configuring your Journeys Template:

• On the VIEW EDITOR tab, click the CTA button in the UI of the template you've chosen.
• Add key-value pairs in the DEEP LINK DATA section.
• Click Save&Close.

Setup via Web SDK

Use .setBranchViewData() to programmatically set one or more of the above redirects within the data array

branch.init(...);
branch.setBranchViewData({data: {'$journeys_cta': 'https://example.com',}});

Dynamic Journeys Layout Customization

You can customize the appearance of a Journey depending on which link referred to the web session. So, you can create a Branch Link with a set of defined keys and values that will change properties such as the title or images when the user is referred to your website from this link.

Note: Not all templates support all override keys. For example, the floating button does not support title, description, or icon image URL (Floating Pills will support the custom liquid tags detailed below). If a creative is to be rendered and the key you've specified does not exist, it is ignored.

Custom Liquid Tags

In addition to using pre-defined keys (e.g. $journeys_title) to dynamically customize the appearance/content of a Journey, you can use custom liquid tags. Custom tags can be inserted in both the View Editor and the CSS Editor when configuring a creative. Then, you can use setBranchViewData() method of the Branch Web SDK to dynamically provide values for these tags. You can also embed those values statically on a page with Branch Meta Tags.

Note: If you include custom liquid tags in your templates and also set a value for a pre-defined key (e.g. $journeys_title) in setBranchViewData(), the value of the pre-defined key will take priority.

Liquid Tag Format

{{ key_name | default_value }}

For example, if you were adding a custom liquid tag in CSS to dynamically control the font size of one of your Journeys’ title, you might use a tag like the one below:

{{ fontSize | 12px }}

And if you were adding a custom liquid tag in your template text, you might use a tag like the one below:

{{ adjective | best }}

Then, to dynamically update values for the “fontSize” and “adjective” variables, you would set values for those variables using setBranchViewData():

branch.init(...);
branch.setBranchViewData({
    data: {
        'fontSize': '20px',
        'adjective': 'most entertaining',
    }
});

Or, you can set the values by embedding Branch Meta Tags on the page:

<meta name="branch:deeplink:fontSize" content="20px" />
<meta name="branch:deeplink:adjective" content="most entertaining" />