Getting Started with Retention.com

This page will help you get started with the Retention.com API.

Suggest Edits

📝About The Retention.com API

This API is very simple to use, but even so, it should not be used in most cases.

We collect events in real-time. To receive our data in real-time, you should use web hooks.

Using the API to fetch the data from Retention.com is a bad idea and a poor use of the events.

The API should primarily be used for uploading a daily suppression file if you're unable to use a native integration.

🔐API Authentication

  • API Authentication: We use an API Key and API ID for authenticating requests. These keys can be created from within the application here (under My Account > API Details). To be as flexible as possible, we allow passing the Key/ID in either the request header, body, or as a query parameter.
  • Via Header: When sending the authentication tokens in the header they would have the format 'api-id' and 'api-key'.
  • Via Params/Body: When sending the authentication tokens in the body or are parameters, they would be in the format 'api_id' and 'api_key'.
  • Examples: The api_id/api-id takes the form of a string such as: '430cc832fe7cd707b1320b8c6a'. The api_key/api-key takes the form of a string such as: '21572420268b05fb52'.

🚨 API Limits

The API is not intended for large scale querying and fetching contacts every 10 minutes.

Web hooks perform much better than an API for processing data from Retention.com. Because our events are in real-time, it makes sense to use web hook unless you are in a very odd circumstance.

The systems use AI monitoring for health, stability, and to track abnormalities. The AI can block an account if it determines there's a threat to the system or if the API is being used improperly or abnormally. This is mostly due to the fact that the only call that should be used by most customers is for uploading a suppression list.

📄 Data Format

Data is returned as a JSON string. You can review each API call for examples.

💬 We're here to help!

If you get stuck, shoot us an email or use the blue icon on the bottom right of any page when logged into your Retention.com account to reach out to us.

Updated about 1 month ago