Gorgias

{/* Generated by scripts/generate-integration-catalog.mjs. Do not edit by hand. */}

At a glance

  • Availability: Experimental (how to enable).
  • Authentication: Basic auth.
  • Connection: HTTP Basic auth with GORGIAS_USERNAME as the username and GORGIAS_API_KEY as the password.
  • Provider documentation: Authentication reference.

Credentials

Set these per environment. See Connect an integration.

VariableRequiredDescription
GORGIAS_USERNAMEYesEmail address of the Gorgias account the API key belongs to (HTTP Basic username) Docs.
GORGIAS_API_KEYYesGorgias REST API key (HTTP Basic password), created under Settings → REST API Docs.
GORGIAS_ACCOUNT_DOMAINNoYour Gorgias account subdomain, e.g. 'acme' for acme.gorgias.com - passed as the accountDomain parameter on every tool Docs.

Setup

  1. Get a Gorgias account: Sign up at https://www.gorgias.com - new accounts start with a free trial you can use for testing. Note your account subdomain (the 'acme' in acme.gorgias.com).
  2. Create a REST API key: In your Gorgias dashboard, open Settings → REST API. Copy the Base API URL (https://<your-domain>.gorgias.com/api), your username (your account email), and create/copy the API key (password).
  3. Store the credentials: Add GORGIAS_USERNAME=<your account email>, GORGIAS_API_KEY=<your API key>, and GORGIAS_ACCOUNT_DOMAIN=<your subdomain> to your .env file. The API uses HTTP Basic auth with email as username and API key as password.
  4. Verify access: Run the List Tickets tool with your account subdomain as accountDomain. You should get back a page of tickets (empty data array on a fresh account).

Provider notes

  • Every tool takes an accountDomain path parameter - pass the value stored in GORGIAS_ACCOUNT_DOMAIN
  • API keys inherit the permissions of the user they belong to; create the key from an account with access to the tickets you need
  • Creating a message with channel 'email' actually emails the customer - use channel 'internal-note' for private notes

Provider API reference.

Tools

ToolAccessDescription
List Tickets<br /><code className="reference-identifier">gorgias__list_tickets</code>ReadList tickets
Get Ticket<br /><code className="reference-identifier">gorgias__get_ticket</code>ReadGet ticket
List Ticket Messages<br /><code className="reference-identifier">gorgias__list_ticket_messages</code>ReadList ticket messages
Create Ticket Message<br /><code className="reference-identifier">gorgias__create_ticket_message</code>WriteCreate ticket message
Create Ticket<br /><code className="reference-identifier">gorgias__create_ticket</code>WriteCreate ticket
List Customers<br /><code className="reference-identifier">gorgias__list_customers</code>ReadList customers
List Users<br /><code className="reference-identifier">gorgias__list_users</code>ReadList users
Update Ticket Status<br /><code className="reference-identifier">gorgias__update_ticket_status</code>WriteUpdate ticket status

Verify the connection

Call a read tool such as gorgias__list_tickets with arguments for your account. Confirm that the result comes from the intended account or workspace before enabling write tools.