> ## Documentation Index
> Fetch the complete documentation index at: https://docs.runalloy.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Retently

> Integration details and setup guide for the Retently connector in Alloy Automation.

## Pre-Built Tooling

| Category                            | Details                                                 |
| ----------------------------------- | ------------------------------------------------------- |
| **Authentication**                  | API Key (Header: Authorization with "api\_key=" prefix) |
| **Two-Way Sync**                    | No                                                      |
| **Events Supported**                | No                                                      |
| **Realtime**                        | Polling                                                 |
| **Supports Rate Limiting**          | Yes                                                     |
| **Authentication Scopes Supported** | N/A (API Key)                                           |

***

## Objects Supported

Alloy Automation supports syncing the following objects from **Retently**:

* **Customers**
* **Surveys**
* **Responses**
* **NPS Scores**
* **Feedback**
* **Campaigns**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                     |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Yes. Retently offers a 7-day free trial with no credit card required. [Start free trial](https://www.retently.com/signup/) |
| **Requires paid sandbox?**                         | No. The trial account can be used for testing and development.                                                             |
| **Requires partnership to obtain authentication?** | No. Any Retently user can generate API keys from their account.                                                            |

***

### Authentication (API Key)

For customers who want to completely whitelabel their authentication experience, you can provide your own developer keys instead of using Alloy Automation's.

<steps>
  <step title="Create Retently Account">
    Sign up for a free trial at [https://www.retently.com](https://www.retently.com) or log in to your existing Retently account
  </step>

  <step title="Navigate to API Settings">
    1. Log in to your Retently dashboard at [https://app.retently.com](https://app.retently.com)
    2. Click on **Settings** in the main navigation
    3. Select **Integrations** or **API** from the settings menu
  </step>

  <step title="Generate API Key">
    1. Find the **API Key** section on the integrations page
    2. Click **Generate API Key** or copy your existing key
    3. Copy the API key to your clipboard
    4. Store it securely (the key provides access to your survey data)
  </step>

  <step title="Configure in Alloy Automation">
    1. In Alloy Automation, enter your Retently API key
    2. The key will be sent in the `Authorization` header with the format: `api_key=YOUR_KEY`
    3. Test the connection to verify authentication
  </step>
</steps>

For detailed API documentation, visit [Retently API Docs](https://www.retently.com/api/).

***

## Use Cases

### 1) NPS survey automation

Automatically trigger NPS surveys through Retently when customers reach key milestones in your product or complete specific actions, measuring satisfaction at critical touchpoints.

### 2) Customer feedback analysis

Sync NPS scores, survey responses, and feedback from Retently into your CRM or customer success platform to track customer satisfaction trends and identify at-risk accounts.

### 3) Customer health scoring

Integrate Retently NPS data with other customer metrics in your data warehouse to build comprehensive customer health scores and predict churn risk.

### 4) Response-based workflows

Trigger automated workflows based on NPS responses - such as alerting customer success teams for detractors or thanking promoters with special offers.

### 5) Multi-channel survey distribution

Coordinate survey distribution across email, SMS, and in-app channels by integrating Retently with your communication platforms for higher response rates.

***

## API Gotchas

* **API key format:** Retently requires the API key to be sent in the Authorization header with the prefix "api\_key=" (e.g., `Authorization: api_key=YOUR_API_KEY`). This is different from standard Bearer token authentication.

* **Rate limiting:** The API enforces rate limits to protect system performance. Implement exponential backoff retry logic when you receive rate limit errors.

* **Survey timing:** When triggering surveys programmatically, be mindful of Retently's built-in survey throttling to prevent over-surveying customers. Check customer survey history before sending.

* **NPS calculation:** NPS scores are calculated automatically by Retently based on responses. Don't attempt to manually calculate NPS - always pull the calculated scores from the API.

* **Customer deduplication:** Retently uses email as the primary customer identifier. Ensure email addresses are properly formatted and deduplicated before syncing customers to avoid creating duplicate records.

> For questions or troubleshooting, contact **[support@runalloy.com](mailto:support@runalloy.com)**.