How do I integrate Retention.com with Braze?

You can integrate your Retention.com account directly with Braze.

An integration between Retention.com and Braze does two things:

  1. Automatically sends contacts acquired in your Retention.com account to Braze.
  2. Ability to set up custom filters to sync filters (ie, send leads from different domains to different lists or ESPs).

What you’ll need

1. Your API URL and API Key. Your API Key can be found in the Braze dashboard by going to Settings > Developer Console. Click Rest API Keys at the top to view current APIs or create a new one.

2. You will have to whitelist Retention.com’s IP addresses, which are subject to change without notice. Please contact support at support[at]retention.com for an updated list.

To get started

1. Click on Integrations from the left navigation panel in Retention.com. Then, click Available Integrations at the top and choose the Braze icon.

2. Paste your API URL and API Key. Click Connect.

3. Click Yes to upload your collected contacts. Next, choose whether you want to enable custom sync options.

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

This feature allows you to filter your Retention.com 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 Retention.com and Robly.com, for example, the landing page domain would be either Retention.com or Robly.com. This field will auto-populate.

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

Referrer URL: This is the URL the contact comes to your site from.

When you’re finished, click Next.

4. Enable the Braze integration. Once you enable the integration, your collection sync settings will apply and begin. Then, click Finish.

5. Once the integration is complete, you will see the integration date, API details, and the option to enable/disable Contact Sync. You can also Remove the integration from this page at the top.

Manually suppress contacts

To prevent collecting contacts already in your Braze account, you will need to manually suppress them by uploading a CSV file.

Suppression lists loaded as a CSV file are converted into encoded MD5s for security reasons. We do not use, share, or resell this data for any purpose other than to prevent users from collecting and paying for contacts they already have.

To upload a Suppression List, click on Suppression Lists in the left-hand navigation.

Here are the file requirements for upload:

  • Your file should only contain ONE column, labeled “email”.
  • You’ll also need to save it as an Excel .CSV file.
  • Maximum file size is 100MB. If your file is larger than this, split it up into several smaller files.

Once the file has uploaded, you will see a green box in the top right corner that says your file has been uploaded and is in the queue to be processed. Once that’s complete, you’ll see the stored file listed under the corresponding date:

After you upload the initial file, you will need to continue uploading a CSV file to suppress contacts. How often you need to upload a CSV suppression list (ex. daily, weekly, bi-weekly, monthly) will depend on how many contacts you collect in Braze.

Turn Contact Sync On/Off

1. To enable/disable Contact Sync, click Integrations > Dots Settings.

2. Click the pencil icon next to Contact Sync. Click Yes next to Upload collected contacts. Click Save.

Remove the integration

1. 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 can contact support at support[at]retention[dot]com.