Skip to main content
All CollectionsIntegrationsOther Integrations
Include a Custom Identifier With Your Grow Contacts & Reclaim Events
Include a Custom Identifier With Your Grow Contacts & Reclaim Events
Updated over 2 months ago

You can pass a custom identifier with the contacts you collect with Retention.com. This identifier will be included in the payload we send via the integrations you have set up, allowing you to connect an email to the identifier provided. You will also be able to view the identifier in your Retention.com account.

This functionality is available to merchants using both Grow and Reclaim, as well as those using either Grow or Reclaim individually.

Example

You include a session_id that would get sent along with the email we resolve for one of your site visitors. This allows you to connect information in your systems that utilize session_id to an email address.


NOTE: We highly recommend anyone using a customer data platform (CDP) to include an identifier that you are utilizing in your CDP.


How to set up the Custom Identifier

The steps for setting up the Custom Identifier depend on the Retention.com products you are using. Expand the appropriate section below and follow the instructions tailored to your integration.

Grow only

1. Ensure you've added the Retention collection script to your website.

Prerequisites


The Custom Identifier code must run before the geq.page() function.

When you call geq.identify(), you must include 'user_id' as the key.

The code for your customer identifier should be appended between the geq.load() function and the closing </script> tag. See the image below:

Custom Identifier code

geq.identify({user_id: '123456'});

2. Replace the value for user_id with your respective identifier.

Custom Identifiers have a limit of up to 55 characters.

3. Add the code to your site:

4. Once you've added the custom identifier to your site, it will be passed to your integration as 'user_id' — and will also appear in Retention.com with the contact as Custom Identifier.

You'll also see the identifier in the CSV file if you download your contacts:

Grow and Reclaim

1. Ensure you've added the Retention collection script to your website.

Prerequisites


The Custom Identifier code must run before the geq.page() function.

When you call geq.identify(), you must include 'user_id' as the key.

The code for your customer identifier should be appended between the geq.load() function and the closing </script> tag. See the image below:

Custom Identifier code

geq.identify({user_id: '123456'});

2. Replace the value for user_id with your respective identifier.

Custom Identifiers have a limit of up to 55 characters.

3. Add the code to your site:

4. This step is for merchants utilizing our Active on Site events. If you are not receiving these events, you can skip to the next step.

Go to your Retention.com dashboard and select "Code Script" from the navigation menu. Look for the edit icon beside "Active on Site Trigger" and click it.

Ensure the toggle for the "geq.identify" function is enabled.

5. Once you've added the custom identifier to your site, it will be passed to your integration as 'user_id' — and will also appear in Retention.com with the contact as Custom Identifier.

You'll also see the identifier in the CSV file if you download your contacts:

Reclaim only

1. Add the Retention base script to your website:

  1. Navigate to the Retention Dashboard.

  2. Go to Code Script and click View Your Script.

  3. Select the "Collection" option.

  4. Exclude the second <script> tag containing the "geq.page()" function.

Prerequisites


The Custom Identifier code must run immediately after the base script.

When you call geq.identify(), you must include 'user_id' as the key.

Custom Identifier code

geq.identify({user_id: '123456'});

2. Replace the value for user_id with your respective identifier.

Custom Identifiers have a limit of up to 55 characters.

3. Add the code to your site:

4. This step is for merchants utilizing our Active on Site events. If you are not receiving these events, you can skip to the next step.

Navigate to your Retention.com dashboard and select "Code Script" from the menu. Next, locate the edit icon next to "Active on Site Trigger" and click on it.

Ensure the toggle for the "geq.identify" function is enabled.

5. Once you've added the custom identifier to your site, it will be passed to your integration as 'user_id' — and will also appear in Retention.com with the contact as Custom Identifier.

You'll also see the identifier in the CSV file if you download your contacts:


How to add an integration identifier

You can also add an integration identifier to your contacts collected by Retention.com. The identifier can be provided to you by your Retention.com client success manager, and is not visible in your contact details (like the above option) since it's added post-collection.


This option is enabled by request, please email support@retention.com if you're interested in adding an integration identifier.

This option is enabled automatically for Klayvio contacts.

Once this setting is enabled by support or your client success manager, the identifying tag will be shared with you directly.



Have questions? Email us at support@retention.com or message us on chats

Did this answer your question?