> ## 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.

# Inveterate

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

## Pre-Built Tooling

| Category                            | Details                |
| ----------------------------------- | ---------------------- |
| **Authentication**                  | API Key (Header-based) |
| **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 **Inveterate**:

* Custom actions and resources (refer to Inveterate API documentation for available endpoints)

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                         |
| -------------------------------------------------- | -------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Contact Inveterate for trial access information at [https://www.inveterate.com/](https://www.inveterate.com/). |
| **Requires paid sandbox**                          | Unknown. Contact Inveterate sales for sandbox availability.                                                    |
| **Requires partnership to obtain authentication?** | No, but you must be an Inveterate customer.                                                                    |

***

### Authentication (API Key)

Inveterate uses API Key authentication passed in the request header.

#### How to obtain your API Key

1. **Log in to your Inveterate account** at [https://app.inveterate.com](https://app.inveterate.com)
2. Navigate to **Settings** or **App Settings** in your dashboard
3. Look for the **API** or **Integrations** section
4. **Generate a new API Key** or copy your existing key
5. Store this key securely - it will be used as the `X-Inveterate-Api-Key` header
6. **Configure the API Key in Alloy Automation**:
   * Header name: `X-Inveterate-Api-Key`
   * Header value: Your generated API key

#### API Documentation

* Inveterate API Endpoint: [https://public.inveterateapi.com](https://public.inveterateapi.com)
* For detailed API documentation, contact Inveterate support or check their developer portal

***

## Use Cases

### 1) Loyalty program data synchronization

Sync customer loyalty data, rewards, and engagement metrics from Inveterate to your CRM, data warehouse, or customer analytics platform for unified customer insights.

### 2) Automated reward fulfillment

Trigger automated workflows when customers reach reward milestones in Inveterate, such as sending personalized emails, creating discount codes, or updating customer segments.

### 3) Cross-platform loyalty tracking

Integrate Inveterate loyalty data with your e-commerce platform, point-of-sale system, or mobile app to provide customers with real-time loyalty status across all touchpoints.

### 4) Customer segmentation

Pull loyalty program participation and engagement data to create sophisticated customer segments based on reward tier, points balance, or redemption behavior.

### 5) Reporting and analytics

Export Inveterate loyalty program data to business intelligence tools for custom reporting on program performance, customer engagement, and reward redemption trends.

***

## API Gotchas

* **Limited public documentation**: Inveterate's public API documentation may be limited. Work directly with Inveterate support to understand available endpoints, request/response formats, and rate limits for your specific use case.
* **API key security**: The `X-Inveterate-Api-Key` header grants full access to your account data. Never expose this key in client-side code or public repositories. Rotate keys regularly and immediately revoke compromised keys.
* **Custom action support**: Since Inveterate is marked with `x-alloy-custom-action: true`, you may need to define custom API calls for specific operations. Work with Alloy Automation support to configure these custom actions based on your Inveterate API needs.
* **Base URL**: Ensure you're using the correct base URL (`https://public.inveterateapi.com`) for API requests. Some Inveterate features may use different endpoints or subdomains.
* **Response formats**: Verify the expected response format (JSON, XML, etc.) for each endpoint. The OpenAPI spec doesn't define specific response schemas, so test your integration thoroughly to ensure proper data parsing.

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