Advanced Analytica Advanced Analytica: IBOM
← All connectors
Gorgias logo

Source connector

Gorgias

Set up Gorgias as a source and move its data into your chosen destination.

Version 0.1.61 community alpha

Gorgias

Gorgias is a customer support helpdesk for ecommerce. This source syncs your helpdesk data from the Gorgias REST API. This includes tickets, messages, customers, and their supporting configuration and activity objects. See Streams for the full list.

Prerequisites

  • A Gorgias account with access to Settings > REST API, where you create API keys.
  • Your Gorgias subdomain. If you sign in at https://acme.gorgias.com, your subdomain is acme.

Set up the Gorgias source

  1. In Gorgias, go to https://YOUR_SUBDOMAIN.gorgias.com/app/settings/api and create an API key.
  2. In Airbyte, create a new Gorgias source and complete the fields below.

The connector uses HTTP basic authentication. Enter your email address as the username and your API key as the password. Private apps, including this connector, use API keys. OAuth2 is only for public Gorgias apps. See the Gorgias authentication reference for details.

Configuration

InputTypeDescriptionDefault Value
usernamestringThe email address of the Gorgias user that owns the API key.
passwordstringThe API key generated in Settings > REST API.
domain_namestringYour Gorgias subdomain, taken from the URL prefix you use to reach Gorgias. For https://acme.gorgias.com, enter acme.
start_datestringThe starting cursor value for incremental syncs, in YYYY-MM-DDTHH:MM:SSZ format. Airbyte rejects any other format. The streams that read in full on every sync ignore this value.

Streams

Stream NamePrimary KeyPaginationSupports Full SyncSupports Incremental
accountdomainNo pagination✅✅
customersidDefaultPaginator✅✅
custom-fieldsidDefaultPaginator✅✅
eventsidDefaultPaginator✅✅
integrationsidDefaultPaginator✅✅
jobsidDefaultPaginator✅✅
macrosidDefaultPaginator✅✅
viewsidDefaultPaginator✅✅
rulesidDefaultPaginator✅✅
satisfaction-surveysidDefaultPaginator✅✅
tagsidDefaultPaginator✅✅
teamsidDefaultPaginator✅✅
ticketsidDefaultPaginator✅✅
messagesidDefaultPaginator✅✅
usersidDefaultPaginator✅✅
views_itemsview_id, idDefaultPaginator✅✅

The views_items stream reads every view’s items returned by the views stream. It adds the parent view’s view_id to each record. The same item can appear in multiple views. Therefore, the stream uses view_id and id together as its primary key.

Rate limits

Gorgias limits API key integrations to 40 requests within 20 seconds. It returns 429 Too Many Requests when you exceed this limit. The connector paces requests within that limit and requests the maximum 100 records per page. Before retrying a throttled request, it waits for the seconds specified in the Retry-after response header. See the Gorgias rate limit reference for details.

Anything using the same credentials shares this request limit. If other integrations use the same API key, syncs can still receive 429 responses. A sync can fail after three retries of a request.

IP allow list

If you use Airbyte Cloud and restrict access to specific IPs, add the Airbyte Cloud IP addresses to your allow list.

Incremental syncs

Each stream has its own cursor field and applies sync state differently:

StreamCursor fieldHow state limits the sync
accountcreated_datetimeReads in full on every sync
customersupdated_datetimeStops paginating at the cursor
custom-fieldsupdated_datetimeFilters records after reading in full
eventscreated_datetimeFilters server-side, with a 5-minute lookback
integrationsupdated_datetimeFilters records after reading in full
jobscreated_datetimeStops paginating at the cursor
macroscreated_datetimeReads in full on every sync
viewscreated_datetimeReads in full on every sync
rulescreated_datetimeStops paginating at the cursor
satisfaction-surveyscreated_datetimeReads in full on every sync
tagscreated_datetimeStops paginating at the cursor
teamscreated_datetimeStops paginating at the cursor
ticketsupdated_datetimeStops paginating at the cursor
messagescreated_datetimeStops paginating at the cursor
userscreated_datetimeStops paginating at the cursor
views_itemscreated_datetimeReads in full on every sync

Streams that stop paginating at the cursor only request pages that can contain new records. Their incremental syncs are therefore much cheaper than a full read. Streams that filter after a full read still request every page from the Gorgias API. They reduce the records Airbyte emits, but not the API calls made during the sync.

Limitations

The following streams use created_datetime as their incremental cursor. Their incremental syncs don’t capture changes made after a record’s creation:

  • jobs: job status transitions, including changes to started_datetime and ended_datetime. The schema doesn’t include updated_datetime.
  • messages: changes to message fields after creation. The schema doesn’t include updated_datetime.
  • rules: rule edits and deactivation changes. The schema includes updated_datetime, but the /api/rules endpoint can’t order by it. Therefore, the stream uses created_datetime as its cursor.
  • tags: tag renames and changes to descriptions or decorations. The schema doesn’t include updated_datetime.
  • teams: team renames and changes to descriptions, decorations, or members. The schema doesn’t include updated_datetime.
  • users: role, name, active-status, and timezone changes. The schema includes updated_datetime, but the /api/users endpoint can’t order by it. Therefore, the stream uses created_datetime as its cursor.

Run a full refresh of the affected stream to capture these changes.

The custom-fields stream only returns custom fields with the object type Ticket. It doesn’t sync custom fields defined on other Gorgias objects, such as customers.

Streams that read in full during every sync capture changes made after creation. These include a macro’s name or a survey’s score and scored_datetime.

The connector doesn’t capture deletions as deletion events. Tickets expose trashed, and tags expose deleted_datetime. However, there is no deletion stream, so deleted records aren’t captured as deletion events.

The incremental sync end_datetime is evaluated when the sync starts. Records created during a sync fall outside that window and are picked up by the next sync.

Changelog

Expand to review
VersionDatePull RequestSubject
0.1.612026-11-0390597Update dependencies
0.1.602026-11-0190358Simplify rate-limit error handling configuration with no change in sync behavior
0.1.592026-10-2789935Update dependencies
0.1.582026-10-2089237Update dependencies
0.1.572026-10-1388643Update dependencies
0.1.562026-10-0687876Update dependencies
0.1.552026-09-2987230Update dependencies
0.1.542026-09-2286646Update dependencies
0.1.532026-09-1586083Update dependencies
0.1.522026-09-0885503Update dependencies
0.1.512026-08-2584910Incremental syncs now avoid re-reading previously-synced data across the applicable Gorgias streams using cursor-aware pagination, server-side date filtering, or client-side filtering. See Incremental syncs for what an incremental sync no longer picks up.
0.1.502026-08-1884643Update dependencies
0.1.492026-08-1183969Update dependencies
0.1.482026-08-0483514Update dependencies
0.1.472026-07-2882941Update dependencies
0.1.462026-07-2182473Update dependencies
0.1.452026-07-1481873Update dependencies
0.1.442026-06-3081090Update dependencies
0.1.432026-06-2380502Update dependencies
0.1.422026-06-1679893Update dependencies
0.1.412026-06-0979345Update dependencies
0.1.402026-06-0278776Update dependencies
0.1.392026-04-2877277Update dependencies
0.1.382026-04-2176614Update dependencies
0.1.372026-03-1774936Update dependencies
0.1.362026-03-1074662Update dependencies
0.1.352026-02-2473115Update dependencies
0.1.342026-01-2071909Update dependencies
0.1.332026-01-1471733Update dependencies
0.1.322025-12-1870485Update dependencies
0.1.312025-11-2570062Update dependencies
0.1.302025-11-1869410Update dependencies
0.1.292025-10-2968809Update dependencies
0.1.282025-10-2168243Update dependencies
0.1.272025-10-1467919Update dependencies
0.1.262025-10-0767412Update dependencies
0.1.252025-09-3066399Update dependencies
0.1.242025-09-0966058Update dependencies
0.1.232025-08-2365350Update dependencies
0.1.222025-08-0964599Update dependencies
0.1.212025-08-0264303Update dependencies
0.1.202025-07-2663845Update dependencies
0.1.192025-07-1963487Update dependencies
0.1.182025-07-1263114Update dependencies
0.1.172025-07-0562553Update dependencies
0.1.162025-06-2862193Update dependencies
0.1.152025-06-2161810Update dependencies
0.1.142025-06-1461147Update dependencies
0.1.132025-05-2460609Update dependencies
0.1.122025-05-1059874Update dependencies
0.1.112025-05-0359240Update dependencies
0.1.102025-04-2658770Update dependencies
0.1.92025-04-1958193Update dependencies
0.1.82025-04-1257708Update dependencies
0.1.72025-04-0557041Update dependencies
0.1.62025-03-2956719Update dependencies
0.1.52025-03-2256041Update dependencies
0.1.42025-03-0855491Update dependencies
0.1.32025-03-0154794Update dependencies
0.1.22025-02-2254335Update dependencies
0.1.12025-02-1550638Update dependencies
0.1.02025-01-3052637Add retries for rate limited streams
0.0.82024-12-2349935Add additional cursor datetime format
0.0.72024-12-2150123Update dependencies
0.0.62024-12-1449219Update dependencies
0.0.52024-12-1148973Starting with this version, the Docker image is now rootless. Please note that this and future versions will not be compatible with Airbyte versions earlier than 0.64
0.0.42024-11-0648378Fix incremental sync format, Auto update schema with additional fields
0.0.32024-10-2947923Update dependencies
0.0.22024-10-2847459Update dependencies
0.0.12024-09-2946221Initial release by @btkcodedev via Connector Builder
Advanced Analytica

Most businesses are sitting on information they can’t use at speed. The people who hold it are busy, and when they leave, the knowledge goes with them. The documents are static, and the processes around them weren’t designed for AI.

Advanced Analytica works with these businesses to turn that information into structured data assets. Once they're integrated, AI systems can govern it, and the business can use it. We bring in the strategy, the specification and the AI skills to rework how the business operates.

MOVE FAST. STAY SAFE.