Integration with Retention
Ira avatar
Written by Ira
Updated over a week ago

Retention is a 3rd party app that brings your shoppers back to buy. If a website visitor abandons your page, bring them back with a targeted email automation to encourage them to return to your site and complete a purchase.

Retention logo

An integration between and Omnisend does three things:

  1. Automatically sends contacts acquired in your account to Omnisend into a list of your choosing.

  2. Automatically suppresses existing contacts in your Omnisend account.

  3. Ability to set up custom filters to sync filters (ie, send leads from different domains to different lists or ESPs).


Setup Process

Firstly, create an API key. To do this click on your brand name in the top right corner -> Store settings:

Click on the 'API keys' section:

Then click the 'Create API Key' button:

Enter the name of your API key, keep default settings and click 'Save'. Then copy the API key that has been created:

We also recommend you create the Tag name in your Retention account you’d like to sync your contacts in Omnisend with before finalizing the integration.

Proceed to your Retention account now. Click on the Integrations tab from the left navigation panel in your account. Then, click Available Integrations at the top and choose the Omnisend icon:

Enter your Omnisend API Key and then click Connect.

Set up your Contact Suppression. Once you enable automatic suppression, will sync your regular, opt-in list from your ESP and add it to your suppression list. This prevents you from paying for contacts you already have. Once you’ve enabled this option, the sync will run daily at 6 p.m. EST.

Choose either YES or NO to suppress contacts. If you choose to automatically suppress your contacts (YES), pick either daily contact suppression (recommended) or one time suppression.

Daily contact suppression: This action will load all of your contacts from Omnisend into your suppression list and will automatically import new contacts every day into your suppression list.

One time suppression: This action will only run once and load your current Omnisend contacts into your suppression list.

You will also need your Recent contacts Segment ID.

From your Omnisend dashboard, click Audience. Then, click Create segment > find 'Date of addition' filter and select it > Set the day value to '2' days:

Then click 'Save & show contacts' button:

Name your segment, and click Save segment.

Go to the segment you created (found under Audience > Segments). Copy all of the text in the URL after /segments/editor/. This is your Segment ID.

Paste the text you copied from the Omnisend URL into the Segment ID text box. Click Next.

Then, decide if you want to upload your collected contacts by choosing either Yes/No. If you choose to sync your contacts, you will then need to choose a Tag to sync them to. Pick a Tag from the drop-down menu. Then, choose whether you want to enable custom sync options.

If you check the box to enable custom sync options, that will display four options: filter by email domain, full or portion of a landing page URL, landing page domain, and state.

This feature allows you to filter your contacts before you send them to your ESP. For example, you can send all contacts who hit different landing pages to separate lists. Or, send all of your California leads to one ESP and Texas leads to another.

Email domain: This field auto-fills/populates with email domains (ex. Gmail, Yahoo Mail, AOL, etc.) from your collected contacts.

Full or portion of a landing page URL: If you've put the script on several pages or the entire site, this field allows you to pull out contacts who have only hit Landing Page A or Landing Page B. This option does not auto-populate, so you will have to add in the exact URL.

Landing page domain: If you added script to both and, for example, the landing page domain would be either or This field will auto-populate.

State: This filter allows you to pull out only contacts from one or more states.

When you're finished, click Next.

Finalliy, enable the integration. Once you enable the integration, your suppression and collection sync settings will apply and begin. Then, click Finish.

Once the integration is complete, you will see the integration date, API details, contact suppression, and the option to set/change the Tag it's synced to. You can also Remove the integration from this page at the top.

Also, contacts collected by Retention will start syncing to your Omnisend audience too. Contact properties synced from Retention are:

  • email address (subscribed status)

  • clicked_at

  • landing_page_url

  • landing_page_domain

  • referrer

  • page_title

  • data_source

Using the Integration

Change the synced Tag

1. To change the Tag you’ve synchronized with, click Integrations > Dots > Settings.

2. Click the pencil icon next to Contact Sync. Click Yes next to Upload collected contacts if you haven't already. Then, choose a new Tag from the dropdown menu. You can also adjust your custom sync options here. Click Save.

Change suppression

1. To change your contact suppression preferences, click Integrations in the left-hand navigation. Then, click the three dots next to the integrated program and select Settings.

2. Click the pencil/edit icon next to Contact Suppression.

3. Click Yes to automatically suppress your contacts. Then, choose whether you want to suppress daily or just this (single) time. When you're done, click Save. We recommend you use daily sync.

Remove the integration

To remove the integration, click Integrations > Dots > Remove.

Sync summary

You can view your daily sync history under Sync Summary on your integration page. It will show you the date, number of completions, if there are any failures, and the number that are in the queue.

To access all of your sync history, click View Full History under Sync Summary. If there's a failure, it will show the email address, what type of failure has occurred under ESP Feedback, and the date and time of the failure.

If you have questions about the error message you see in your Retention account, you can contact Retention team at [email protected].

Did this answer your question?