> For the complete documentation index, see [llms.txt](https://docs.stackai.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.stackai.com/integrations/catalog/gorgias.md).

# Gorgias

Gorgias is an ecommerce customer support platform for managing tickets, messages, and customers.

### Connectors

Choose the connector that matches your authentication method. The options below use the names shown in StackAI.

| Connector | Authentication |
| --------- | -------------- |
| Gorgias   | Credentials    |

#### Gorgias

Connect to Gorgias with an account domain, email, and API key.

**Set up in Gorgias**

1. Prepare the Gorgias account or service that the workflow will access. Grant access to the required resources and operations.
2. **Domain:** Your Gorgias account subdomain from https\://\<domain>.gorgias.com.
3. **API Key:** A private-app API key generated in Gorgias.

**Set up in StackAI**

1. Open **Settings → Connections**, add a connection, and select **Gorgias**.
2. Enter the credentials and connection details in the fields below.
3. Save the connection and check its connection status. Select this saved connection when configuring an action or feature that uses it.

**Connection fields**

| StackAI field | Required | What to enter                                                                                                                 |
| ------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------- |
| Domain        | Yes      | Your Gorgias account subdomain from https\://\<domain>.gorgias.com.                                                           |
| Account Email | Yes      | The email address of the Gorgias user that owns the API key.                                                                  |
| API Key       | Yes      | A private-app API key generated in Gorgias. [Provider instructions](https://developers.gorgias.com/reference/authentication). |

#### Verify the connection

Check that the connection is healthy. Then run a read operation against a resource the connected account can access. A successful connection check confirms authentication; it does not guarantee permission for every action.

If access is denied, check the credential or OAuth permissions, the selected account or environment, and access to the specific resource. Update expired credentials or reconnect after permissions change.

### Use an action

1. Add the required **Gorgias** action to the workflow.
2. Select a connection when the action requests one.
3. Complete the required fields. Use the reference picker when a value comes from another workflow step.
4. Run the workflow and inspect the action’s output. Check the result before using it in a later step.

### Actions

#### Create Ticket

Create a ticket in Gorgias.

**Inputs**

| Field           | Type            | Required | Description                                                                              |
| --------------- | --------------- | -------- | ---------------------------------------------------------------------------------------- |
| Subject         | string          | Yes      | Ticket subject.                                                                          |
| Initial Message | textarea        | Yes      | Initial customer message.                                                                |
| Customer Email  | string          | Yes      | Email of the customer opening the ticket.                                                |
| Priority        | select (string) | No       | Initial ticket priority. Available values: Critical, High, Normal, Low. Default: normal. |

**Outputs**

| Field     | Type    | Description        |
| --------- | ------- | ------------------ |
| Ticket ID | integer | Created ticket ID. |
| Ticket    | dict    | Created ticket.    |

#### Add Message to Ticket

Add a message or internal note to a Gorgias ticket.

**Inputs**

| Field          | Type             | Required | Description                                                                  |
| -------------- | ---------------- | -------- | ---------------------------------------------------------------------------- |
| Ticket ID      | integer          | Yes      | Ticket to add the message to.                                                |
| Message        | textarea         | Yes      | Plain-text message body.                                                     |
| Internal Note  | boolean          | No       | Add a private note instead of a public API message. Default: true.           |
| Sender User ID | select (integer) | Yes      | Gorgias user sending the message. Options load from the selected connection. |

**Outputs**

| Field      | Type    | Description         |
| ---------- | ------- | ------------------- |
| Message ID | integer | Created message ID. |
| Message    | dict    | Created message.    |

#### Update Ticket

Update a ticket in Gorgias.

**Inputs**

| Field            | Type             | Required | Description                                                         |
| ---------------- | ---------------- | -------- | ------------------------------------------------------------------- |
| Ticket ID        | integer          | Yes      | Ticket to update.                                                   |
| Subject          | string           | No       | New ticket subject.                                                 |
| Status           | select (string)  | No       | New ticket status. Available values: Open, Closed.                  |
| Priority         | select (string)  | No       | New ticket priority. Available values: Critical, High, Normal, Low. |
| Assignee User ID | select (integer) | No       | User to assign.                                                     |
| Assignee Team ID | select (integer) | No       | Team to assign.                                                     |
| Customer ID      | integer          | No       | Customer to associate.                                              |
| Tag Names        | array            | No       | Replacement ticket tags.                                            |
| Unread           | boolean          | No       | Mark the ticket read or unread.                                     |

**Outputs**

| Field     | Type    | Description        |
| --------- | ------- | ------------------ |
| Ticket ID | integer | Updated ticket ID. |
| Ticket    | dict    | Updated ticket.    |

#### List Tickets

List tickets in Gorgias.

**Inputs**

| Field       | Type             | Required | Description                                                                                                                                 |
| ----------- | ---------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| Limit       | integer          | No       | Maximum tickets to return. Minimum: 1. Maximum: 100. Default: 30.                                                                           |
| Cursor      | string           | No       | Pagination cursor.                                                                                                                          |
| Customer ID | integer          | No       | Only tickets for this customer.                                                                                                             |
| View ID     | select (integer) | No       | Only tickets matching this view.                                                                                                            |
| External ID | string           | No       | Ticket external ID filter.                                                                                                                  |
| Order By    | select (string)  | No       | Ticket ordering. Available values: Created (Newest), Created (Oldest), Updated (Newest), Updated (Oldest). Default: created\_datetime:desc. |

**Outputs**

| Field           | Type        | Description                         |
| --------------- | ----------- | ----------------------------------- |
| Tickets         | dict\_array | Returned tickets.                   |
| Next Cursor     | string      | Cursor for the next page.           |
| Previous Cursor | string      | Cursor for the previous page.       |
| Total Resources | integer     | Total tickets matching the filters. |

#### Search Customers

Search customers in Gorgias.

**Inputs**

| Field                    | Type    | Required | Description                                                              |
| ------------------------ | ------- | -------- | ------------------------------------------------------------------------ |
| Query                    | string  | Yes      | Name, email, phone, or contact address to search.                        |
| Maximum Results          | integer | No       | Maximum customers to return. Minimum: 1. Maximum: 50. Default: 10.       |
| Include Contact Channels | boolean | No       | Also search phone numbers and additional email addresses. Default: true. |

**Outputs**

| Field      | Type        | Description               |
| ---------- | ----------- | ------------------------- |
| Customers  | dict\_array | Matching customers.       |
| Raw Result | dict        | Complete search response. |

### Important behavior

Actions that create, update, send, or delete data can change the connected service. Review their inputs before running them. A retry can repeat an operation; consider this when configuring retries for actions that change data.

The catalog lists the fields and capabilities available in the supplied provider definition. Availability can also depend on your deployment and organization’s Feature Access settings.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.stackai.com/integrations/catalog/gorgias.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
