InTouch Hub · Blue Isle Software

Gorgias

Handle e-commerce support tickets and customer messages in Gorgias via the Gorgias REST API.

Provided free and as is, without warranty of any kind — including merchantability, fitness for a particular purpose, and the accuracy or completeness of any result. See the licence. You are responsible for checking what this produces before relying on it.

closeemailhelpdesklogmessagestatussupportsupport-helpdesktickettickets

Gorgias

Handle e-commerce support tickets and customer messages in Gorgias via the Gorgias REST API.

What It Does

Connects to a Gorgias helpdesk account to read support tickets, look up customers, and post reply messages. Useful for automation workflows that need to pull open ticket data, check customer records, or close the loop on a support conversation.

Authentication

Gorgias uses HTTP Basic authentication. The username is your Gorgias account email and the password is an API key.

  1. Log in to your Gorgias account.
  2. Go to Settings > REST API.
  3. Click Create API key and copy the key.
  4. Supply your subdomain (the {domain} part of https://{domain}.gorgias.com), your account email, and the API key as tool inputs.

No OAuth flow is required — a single API key is sufficient.

Operations

operation Method Endpoint Required extra inputs
list_tickets GET /api/tickets
get_ticket GET /api/tickets/{ticketId} ticketId
list_customers GET /api/customers
create_message POST /api/tickets/{ticketId}/messages ticketId, messageBody

Inputs

Name Required Description
apiKey yes Gorgias API key
operation yes One of: list_tickets, get_ticket, list_customers, create_message
domain yes Your Gorgias subdomain (e.g. mystore)
email yes Gorgias account email (Basic auth username)
ticketId for get_ticket, create_message Numeric ticket ID
limit no Page size 1-100 (default 30) for list operations
cursor no Pagination cursor returned by a previous list call
orderBy no Sort for list_tickets: created_datetime:asc, created_datetime:desc, updated_datetime:asc, or updated_datetime:desc
customerEmail no Filter list_customers by email address
messageBody for create_message Plain-text or HTML body of the reply
senderEmail no Sender email for create_message (defaults to email)

Outputs

Name Description
result Full JSON response body from the Gorgias API
status HTTP status code as a string (e.g. "200", "201")

Examples

List open tickets (most recent first):

operation: list_tickets
domain: mystore
email: [email protected]
apiKey: <key>
orderBy: created_datetime:desc
limit: 10

Fetch a specific ticket:

operation: get_ticket
domain: mystore
email: [email protected]
apiKey: <key>
ticketId: 12345

Post a reply to ticket 12345:

operation: create_message
domain: mystore
email: [email protected]
apiKey: <key>
ticketId: 12345
messageBody: "Hi! Your order has shipped. Tracking: 1Z999AA10123456784"

Search customers by email:

operation: list_customers
domain: mystore
email: [email protected]
apiKey: <key>
customerEmail: [email protected]

Publishes

The keys a later task may reference as {{taskName.key}}. Referencing anything not listed here resolves to nothing at run time.

Input Properties

Every property this tool accepts, from its own tool.iml.

Property Type Required Default Description
apiKey string yes DEPRECATED — bind an API Key credential to the task with credentialName instead. A key pasted here is stored in the workflow definition in clear and appears in every export of it. Still honoured for workflows built before the change.
operation string yes One of: list_tickets, get_ticket, list_customers, create_message
domain string no Your Gorgias subdomain (the {domain} in https://{domain}.gorgias.com). Required.
email string no Gorgias account email used as the HTTP Basic auth username. Required.
ticketId string no Ticket id for get_ticket and create_message.
limit string no Optional page size (1-100, default 30) for list_tickets / list_customers.
cursor string no Optional pagination cursor for list_tickets / list_customers.
orderBy string no Optional sort for list_tickets: created_datetime:asc/desc or updated_datetime:asc/desc.
customerEmail string no Optional email filter for list_customers.
messageBody string no Message text/HTML body for create_message.
senderEmail string no Optional sender email for create_message (defaults to the account email).