Skip to main content

​
Overview

The Retain API lets you send user and event data from your application. Use it to power churn prevention, health scores, and customer analytics.

​
Endpoints

​
Flow

  1. Identify users when they sign up or when their profile changes.
  2. Track events as users interact with key features of your product.
Always call /identify before /track. Events can only be recorded for users that have been identified.

​
Authentication

To authenticate, add an Authorization header with the value Basic rk-xxxxxxxxx, where rk-xxxxxxxxx is your Project Token.
See the authentication guide for details.

​
Response codes

Retain uses standard HTTP codes to indicate the success or failure of your requests. In general, 2xx codes correspond to success, 4xx codes are for client errors (invalid request, auth, or resource not found), and 5xx codes are for server issues.
Check Errors for a comprehensive breakdown of all possible API errors, including the response format and error codes.

​
Next steps

Authentication

Get and use your Project Token.

Identify

Identify users in Retain.