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

# Gorgias

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

## Pre-Built Tooling

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

***

## Objects Supported

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

* **Account**
* **Customers**
* **Events**
* **Integrations**
* **Jobs**
* **Macros**
* **Rules**
* **Satisfaction Surveys**
* **Search**
* **Statistics**
* **Tags**
* **Tickets**
* **Ticket Messages**
* **Users**
* **Views**
* **Widgets**

***

## Set Up Guide

### Trial Access

| Question                                           | Answer                                                                                                                               |
| -------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| **Offers free trial?**                             | Yes. Gorgias offers a 7-day free trial with access to all features. Sign up at [https://www.gorgias.com/](https://www.gorgias.com/). |
| **Requires paid sandbox?**                         | No. You can use the trial account for testing.                                                                                       |
| **Requires partnership to obtain authentication?** | No. API access is available to all Gorgias accounts.                                                                                 |

***

### Authentication (API Key)

Gorgias uses API key authentication with Bearer token format.

#### Obtain your API key

1. Log in to your Gorgias account at https\://\[your-subdomain].gorgias.com
2. Navigate to **Settings** → **REST API** (or **Settings** → **API** in older versions)
3. Click **Create API Key** or **Generate New API Key**
4. Provide a name for your API key (e.g., "Alloy Automation Integration")
5. Copy the generated **API Key** (this will be your Bearer token)
6. **Important**: Save the API key immediately—you won't be able to view it again after leaving the page
7. The API key should be used as a Bearer token in the Authorization header: `Authorization: Bearer YOUR_API_KEY`

#### Additional configuration

* Note your Gorgias subdomain (the part before `.gorgias.com` in your URL), as this is required for API requests
* API keys have full access to your account—treat them like passwords and store securely
* You can create multiple API keys for different integrations and revoke them individually if needed

#### Getting Started

* **Sign up for Gorgias**: [https://www.gorgias.com/](https://www.gorgias.com/)
* **API Documentation**: [https://developers.gorgias.com/](https://developers.gorgias.com/)
* **Getting Started Guide**: [https://docs.gorgias.com/en-US/api-83155](https://docs.gorgias.com/en-US/api-83155)
* **REST API Reference**: [https://api.gorgias.com](https://api.gorgias.com)

***

## Use Cases

### 1) Unified customer support ticketing

Centralize support tickets from Gorgias into your internal systems or other customer support platforms, enabling cross-platform ticket management and consolidated reporting across your support channels.

### 2) Customer profile enrichment

Sync customer data between Gorgias and your CRM or data warehouse, enriching support tickets with purchase history, customer lifetime value, and behavioral data for more personalized support experiences.

### 3) Automated ticket tagging and routing

Use automation to tag incoming tickets based on content, customer attributes, or order data, then route them to the appropriate team or trigger specific workflows based on those tags.

### 4) Support analytics and reporting

Pull ticket statistics, satisfaction survey results, and agent performance data into your business intelligence tools to create comprehensive support dashboards and track key support metrics.

### 5) Macro and template synchronization

Programmatically create and update response macros across your support team, ensuring consistent messaging and enabling rapid deployment of new templates when policies or products change.

***

## API Gotchas

* **Subdomain requirement**: All API requests must be made to your specific subdomain URL (`https://[your-subdomain].gorgias.com`). The subdomain is unique to your account and cannot be omitted.

* **Rate limiting**: Gorgias implements rate limiting on API requests. If you exceed the limit, you'll receive a `429 Too Many Requests` response. Implement exponential backoff and respect rate limit headers to avoid throttling.

* **Pagination**: List endpoints return paginated results. Always check for pagination parameters in responses and implement proper pagination handling to retrieve all records, especially for large datasets like tickets or customers.

* **Webhook dependencies**: Some real-time features require webhook setup. For pure API integration, you'll need to use polling, which may have delays depending on your polling frequency and rate limits.

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