This page covers the Gorgias connection setup. Once connected, see Ticket Flow for how messages are processed and handed off.
Before you start
Gorgias account with API access
Gorgias account with API access
You need a Gorgias helpdesk on a plan that includes REST API access. You also need admin permissions to create API keys and configure webhooks.
Admin access in OpenCX
Admin access in OpenCX
Only organization admins can connect integrations. Confirm your role at Settings → Organization.
A dedicated Gorgias user for the AI
A dedicated Gorgias user for the AI
The AI only processes tickets assigned to a specific Gorgias user. Create a dedicated user (e.g. “AI Agent”) in Gorgias so your reps can distinguish AI-handled tickets from their own.
Setup
Generate an API key in Gorgias
In your Gorgias helpdesk, go to Settings → REST API and create a new API key with full access.The API key is a Base64-encoded string combining your email and token. Gorgias shows this on the REST API page.
Find your domain prefix
Your domain prefix is the subdomain of your Gorgias helpdesk URL. If your helpdesk is at
acme.gorgias.com, the domain prefix is acme.Find your default user ID
The default user ID is the Gorgias user the AI operates as. To find it:
- Go to Settings → REST API in Gorgias.
- Open the API explorer or use the
/usersendpoint. - Find the user you created for the AI and note their numeric ID.
The AI only processes tickets assigned to this user. Tickets assigned to anyone else are ignored — your human agents’ work is never interrupted.
Enter credentials in OpenCX
Open Settings → Integrations in your OpenCX dashboard. Select Gorgias and enter:
Click Test & Save. OpenCX validates the credentials by calling the Gorgias API. If validation fails, double-check that the API key has not been revoked and the domain prefix is correct.
| Field | Value |
|---|---|
| API Key | The Base64-encoded API key from Gorgias Settings → REST API. |
| Domain Prefix | Your Gorgias subdomain (e.g. acme from acme.gorgias.com). |
| Default User ID | The numeric Gorgias user ID for the AI agent. |
Copy the webhook URL into Gorgias
After credentials are saved, OpenCX displays a webhook URL. Copy it and configure a webhook in Gorgias:
- In Gorgias, go to Settings → Integrations → HTTP Integration (or Settings → Webhooks depending on your Gorgias version).
- Create a new webhook with the URL you copied from OpenCX.
- Subscribe to ticket message created events so Gorgias notifies OpenCX when customers send messages.
Settings reference
All settings are configured at Settings → Integrations → Gorgias.| Setting | Purpose | Required |
|---|---|---|
| API Key | Authenticates OpenCX with the Gorgias API. Base64-encoded. | Yes |
| Domain Prefix | Your Gorgias subdomain (e.g. acme). Determines the API endpoint. | Yes |
| Default User ID | The Gorgias user the AI operates as. Only tickets assigned to this user are processed. | Yes |
Configure a Gorgias workflow for handoff routing
After setup, create a workflow rule in Gorgias to route handed-off tickets to your human agents. When the AI hands off, it reassigns the ticket to the configured default team. A Gorgias rule that triggers on team assignment can then route the ticket to the right agent.Without a workflow rule, handed-off tickets stay in the default team’s queue but are not automatically assigned to a specific agent. Your reps can still pick them up manually.
Disconnecting
To remove the Gorgias integration, open Settings → Integrations → Gorgias and click Disconnect (or delete the saved credentials). This stops webhook processing. Existing OpenCX sessions are preserved but no longer receive updates from Gorgias.Also remove the webhook URL from your Gorgias settings to stop Gorgias from sending events to an inactive endpoint.
Related Documentation
Ticket Flow
How messages flow, handoff behavior, and what your reps see.
Troubleshooting
Credentials failing, webhook silent, AI not replying.
Gorgias Overview
What the integration does and supported channels.
Handoff Settings
Global handoff rules and office hours.