This technical help document will guide you through the process of integrating with Iterable, a powerful marketing automation platform that gives you the ability to orchestrate cross-channel marketing campaigns in real-time. . We will cover various scenarios for enhancing user navigation and engagement by utilizing both standard URLs and query parameters. By the end of this guide, you'll be able to seamlessly integrate Iterable into your application's navigation flow.

Why Iterable + Tapcart?

With the Iterable and Tapcart integration, you can activate and personalize real-time email and SMS alongside push campaigns with user-generated in-app events.

Track in-app events within Iterable
Unify cross-channel marketing campaigns
Increase conversions with personalized and timely engagements

How to Connect Iterable + Tapcart?

Here are the prerequisites before setting up the integration.

Before you begin the integration process, ensure you have the following prerequisites:

Access to your Iterable account.
A clear understanding of your application's native URLs and their corresponding destinations.
Basic knowledge of query parameters and URL encoding.

Known Limitations

Wakeup (iOS): We do not support this at this current time (10/11/23)

Integrating with Iterable requires a brand new build of the mobile app AFTER the information is configured in your dashboard.

Type of project supported: Email based Only

We do not currently support:
- UserID-based: Uses userId as a unique identifier.
- Hybrid: Uses email and userId as unique identifiers.

Steps to Configure the Integration

Setting Up Tracking Domains:

If you wish to set up a tracking domain for your email sends then you will need to configure this in the Iterable dashboard. You will need:

Apple app site association file
- App IDs
Android asset links json file
- Know the package name and namespace
- Sha256 certificate fingerprints
Work with Iterable on setting up the tracking domain

Steps to Enable Domains in Iterable

Open your Iterable dashboard
Navigate to 'Settings' and select 'Domains'
Add a new tracking domain (or edit a pre-existing one)
Edit the deep link destination domain:
1. Add the Android assetlinks.json and Apple app site association file and enable it
2. To find the appID use the bundle identifier (ask your Tapcart account manager if you need help).
Go back to 'Settings' and select 'Apps and Websites' to add your new apps
From here you can add iOS
Next add Android

Steps to Configure Iterable in Tapcart

Open the Tapcart dashboard
Navigate to 'Integrations' and select 'Iterable'
Enter the Iterable Client API key
- This can be found HERE
- Important Note: Remember this API key, once set up in Iterable you can not re-read the key
Add the tracking domain that was set up in the previous step
- In our example it was clicks.e.zulily.com

How to Setup Deep Linking in the App?

Landing Natively to Homepage, PLP, and PDP

You can direct users to various locations within your application using standard Shopify URLs:

Homepage: site.com/
Collection Page: site.com/collections/##{{collection}}
Product Page: site.com/products/##{{product_handle}}
Web View: site.com/##{{any_custom_path}}

Landing Natively to All Other App Pages

Use the Tapcart Route (TCR) query parameter to route users to specific native locations:

Account: ?tcr=account
Cart: ?tcr=cart
Order: ?tcr=orders
Multi Tab on Homepage: ?tcr=%2Fhome%3FtabIndex%3D1 (encoded: ?tcr=/home?tabIndex=1)
Hybrid Pages: ?tcr=hybrid-pages/<route_id>

Example URLs

Here are examples of how URLs with the TCR query parameter will appear for different native locations:

Account: https://www.yourwebsite.com/account?tcr=account
Cart: https://www.yourwebsite.com/cart?tcr=cart
Order: https://www.yourwebsite.com/?tcr=orders
Multi Tab on Homepage: https://www.yourwebsite.com/ends-soon?tcr=%2Fhome%3FtabIndex%3D1
Hybrid Pages: https://www.yourwebsite.com/?tcr=hybrid-pages/<route_id>

Deep Linking to app from an email

Follow these steps to send an Iterable email with deep linking:

Login to Iterable
Navigate to the 'Campaigns' section
Choose an existing campaign to modify or create a new one
Edit the content of your campaign to include clickable elements (links or buttons) that users will interact with
Modify hyperlinks
- For each element requiring navigation, adjust the hyperlink associated with it.
Add Query Parameter
- Append the TCR query parameter to the URL for native location routing.
- Example: To direct users to the cart, add ?tcr=cart to the URL.
Before finalizing the campaign, use the preview feature to verify that the hyperlinks and query parameters are working as expected.
Once that's completed, simply save your changes and launch the campaign!

Deep Linking to app from a push notification

Following these steps to send an Iterable push with deep linking:

Login to Iterable
Navigate to the 'Campaigns' section
Choose an existing campaign to modify or create a new one
Edit the content with 'Open URL' action
- Edit the content of your campaign to include an Open Action of type 'Open URL'
Add the URL
- For each element requiring navigation, adjust the hyperlink associated with it.
Add Query Parameter
- Append the TCR query parameter to the URL for native location routing.
- Example: To direct users to the cart, add ?tcr=cart to the URL.
Before finalizing the campaign, use the preview feature to verify that the hyperlinks and query parameters are working as expected.
Once that's completed, simply save your changes and launch the campaign!

Considerations

By integrating with Iterable using both standard URLs and query parameters, you can significantly enhance user navigation and engagement within your application. Prioritize thorough testing to ensure that all routing and parameter usage works as intended. If you encounter any challenges, refer to Iterable's official documentation or seek assistance from their support team.

Iterable + Tapcart