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

# Kustomer

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

## Pre-Built Tooling

| Category                            | Details                |
| ----------------------------------- | ---------------------- |
| **Authentication**                  | Bearer Token (API Key) |
| **Two-Way Sync**                    | No                     |
| **Events Supported**                | No                     |
| **Realtime**                        | Polling                |
| **Supports Rate Limiting**          | Yes                    |
| **Authentication Scopes Supported** | N/A (Bearer Token)     |

***

## Objects Supported

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

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

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                                                    |
| -------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Offers free trial?**                             | Contact Kustomer for trial access at [https://www.kustomer.com/](https://www.kustomer.com/). Kustomer typically offers demos and proof-of-concept trials. |
| **Requires paid sandbox**                          | Yes. Kustomer is an enterprise platform requiring a paid subscription.                                                                                    |
| **Requires partnership to obtain authentication?** | No, but you must be a Kustomer customer.                                                                                                                  |

***

### Authentication (Bearer Token)

Kustomer uses HTTP Bearer authentication with an API key.

#### How to obtain your API Key

1. **Log in to your Kustomer account** at [https://app.kustomerapp.com](https://app.kustomerapp.com)
2. Navigate to **Settings** > **Security** > **API Keys**
3. Click **Create API Key**
4. Configure the API key:
   * Give it a descriptive name (e.g., "Alloy Automation Integration")
   * Set the appropriate permissions based on your integration needs
   * Choose between User Token (acts as a specific user) or Organization Token (acts as the organization)
5. Copy the generated API key immediately (you won't be able to see it again)
6. **Configure the Bearer token in Alloy Automation**:
   * Authentication type: Bearer Token
   * Token value: Your generated API key

#### API Documentation

* Kustomer API Documentation: [https://developer.kustomer.com/kustomer-api-docs/reference/introduction](https://developer.kustomer.com/kustomer-api-docs/reference/introduction)
* Authentication Guide: [https://developer.kustomer.com/kustomer-api-docs/reference/authentication](https://developer.kustomer.com/kustomer-api-docs/reference/authentication)
* API Keys Management: Available in Kustomer Settings > Security

***

## Use Cases

### 1) Unified customer support platform

Sync customer conversations, tickets, and support history from Kustomer to your CRM, data warehouse, or analytics platform for comprehensive customer insights.

### 2) Automated customer data enrichment

Automatically update Kustomer customer profiles when data changes in your product, CRM, or other systems, ensuring support agents always have the latest customer context.

### 3) Cross-platform ticket management

Integrate Kustomer conversations with other ticketing systems, project management tools, or escalation platforms to enable seamless workflows across support teams.

### 4) Support analytics and reporting

Pull Kustomer conversation data, resolution times, and customer satisfaction metrics into business intelligence tools for custom reporting and performance analysis.

### 5) Proactive customer support

Trigger Kustomer conversations or notifications based on customer behavior, product usage, or external events to provide proactive support before customers reach out.

***

## API Gotchas

* **API key types**: Kustomer offers User Tokens and Organization Tokens. User Tokens act on behalf of a specific user and inherit their permissions, while Organization Tokens have broader access. Choose the appropriate type based on your use case and required permissions.
* **Base URL configuration**: Ensure you're using the correct base URL (`https://api.kustomerapp.com/v1/`). Note the `/v1/` version prefix in the URL.
* **Bearer token format**: When making API requests, include your API key in the Authorization header as `Bearer YOUR_API_KEY`. Do not include additional text like "Token" or quotes around the key.
* **Rate limiting**: Kustomer enforces API rate limits per organization. Monitor the rate limit headers in API responses (`X-RateLimit-Limit`, `X-RateLimit-Remaining`, `X-RateLimit-Reset`) and implement exponential backoff when approaching limits.
* **Custom objects and fields**: Kustomer allows extensive customization of objects and fields. Your integration may need to account for custom fields specific to your Kustomer instance. Use the metadata endpoints to discover available fields.
* **Webhook support**: While not detailed in the basic OpenAPI spec, Kustomer supports webhooks for real-time event notifications. Consider using webhooks in addition to polling for more responsive integrations.

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