Skip to main content

Gorgias source

Use the Gorgias source connector to connect to the Gorgias API.

Status

This connector is currently in development.

  • Connection (credential validation): Supported
  • Catalog discovery: Not yet implemented
  • Data extraction/sync: Not yet implemented

Requirements

  • A Gorgias account subdomain (your helpdesk URL is typically https://<subdomain>.gorgias.com)
  • A Gorgias user email
  • A Gorgias API key

Authentication

This connector authenticates to Gorgias using HTTP Basic Auth:

  • Username: your Gorgias user email
  • Password: your Gorgias API key

During setup, the connector validates credentials by calling:

  • GET https://<subdomain>.gorgias.com/api/account

Setup

  1. In Gorgias, create or retrieve an API key for the user you want to authenticate as.
  2. Collect the following values:
    • Subdomain (account subdomain only)
    • Email
    • API key
  3. Configure the connector using the fields below.

Configuration reference

FieldTypeRequiredDescription
subdomainstringYour Gorgias account subdomain (for example, acme). Do not include https:// or .gorgias.com.
emailstringThe email address of the Gorgias user used for authentication.
api_keystringThe API key for the authenticated Gorgias user.

Subdomain formatting rules

The connector expects a plain subdomain. These are accepted examples:

  • acme
  • acme.gorgias.com (the connector will normalize this to acme)

These are not valid:

  • https://acme.gorgias.com
  • acme.gorgias.com/api
  • any value containing /, :, @, or an empty value

Streams

No streams are currently exposed. Catalog discovery and extraction are still in development.