Gorgias - Nango Docs

Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

Pre-built tooling

✅ Authorization

Tools	Status
Pre-built authorization (OAuth)	✅
Credentials auto-refresh	✅
Auth parameters validation	✅
Pre-built authorization UI	✅
Custom authorization UI	✅
Expired credentials detection	✅

✅ Read & write data

Tools	Status
Pre-built integrations	✅
API unification	✅
2-way sync	✅
Webhooks from Nango on data modifications	✅
Real-time webhooks from 3rd-party API	🚫 (time to contribute: <48h)
Proxy requests	✅

✅ Observability & data quality

Tools	Status
HTTP request logging	✅
End-to-end type safety	✅
Data runtime validation	✅
OpenTelemetry export	✅
Slack alerts on errors	✅
Integration status API	✅

✅ Customization

Tools	Status
Create or customize use-cases	✅
Pre-configured pagination	🚫 (time to contribute: <48h)
Pre-configured rate-limit handling	🚫 (time to contribute: <48h)
Per-customer configurations	✅

Others

Function name	Description	Type	Source code
`add-ticket-tags`	Add one or more existing tags to a ticket (additive, does not remove existing tags).	Action	🔗 Github
`bulk-update-custom-fields`	Bulk update custom field definitions.	Action	🔗 Github
`cancel-job`	Cancel a pending/running bulk-operation job	Action	🔗 Github
`create-custom-field`	Create a custom field definition for tickets or customers.	Action	🔗 Github
`create-customer`	Create a customer with one or more contact channels.	Action	🔗 Github
`create-macro`	Create a macro with one or more actions (e.g. setResponseText).	Action	🔗 Github
`create-rule`	Create an automation rule with JavaScript-like condition/action code.	Action	🔗 Github
`create-satisfaction-survey`	Create a satisfaction survey record for a ticket and customer.	Action	🔗 Github
`create-tag`	Create a tag.	Action	🔗 Github
`create-team`	Create a team.	Action	🔗 Github
`create-ticket-message`	Add a new message to an existing ticket.	Action	🔗 Github
`create-ticket`	Create a ticket, finding or creating the customer by email/phone and choosing the phone vs. email message channel based on account settings.	Action	🔗 Github
`create-user`	Create a new user with a role in Gorgias. Defaults to agent if a role is not provided.	Action	🔗 Github
`create-view`	Create a view (saved filter) for tickets or customers.	Action	🔗 Github
`delete-customer-custom-field-value`	Clear a single custom field value on a customer.	Action	🔗 Github
`delete-customer`	Delete a customer.	Action	🔗 Github
`delete-macro`	Delete a macro	Action	🔗 Github
`delete-rule`	Delete a rule.	Action	🔗 Github
`delete-tag`	Delete a tag.	Action	🔗 Github
`delete-tags`	Delete multiple tags in one call.	Action	🔗 Github
`delete-team`	Delete a team	Action	🔗 Github
`delete-ticket-custom-field-value`	Clear a single custom field value on a ticket	Action	🔗 Github
`delete-ticket-message`	Delete a message from a ticket.	Action	🔗 Github
`delete-ticket`	Delete a ticket.	Action	🔗 Github
`delete-user`	Delete a user in Gorgias.	Action	🔗 Github
`delete-view`	Delete a view.	Action	🔗 Github
`get-account`	Get details about the current Gorgias account.	Action	🔗 Github
`get-custom-field`	Retrieve a single custom field definition.	Action	🔗 Github
`get-customer`	Retrieve a single customer, including their contact channels.	Action	🔗 Github
`get-event`	Retrieve a single event.	Action	🔗 Github
`get-integration`	Retrieve a single integration’s configuration.	Action	🔗 Github
`get-job`	Retrieve a single job’s status/progress.	Action	🔗 Github
`get-macro`	Retrieve a single macro.	Action	🔗 Github
`get-rule`	Retrieve a single automation rule, including its code and parsed AST.	Action	🔗 Github
`get-satisfaction-survey`	Retrieve a single satisfaction survey.	Action	🔗 Github
`get-stats-overview`	Retrieve a named statistic over a date range.	Action	🔗 Github
`get-tag`	Retrieve a single tag.	Action	🔗 Github
`get-team`	Retrieve a single team.	Action	🔗 Github
`get-ticket-message`	Retrieve a single message on a ticket.	Action	🔗 Github
`get-ticket`	Retrieve a single ticket, including its full messages array.	Action	🔗 Github
`get-user`	Retrieve a single user.	Action	🔗 Github
`get-view`	Retrieve a single view.	Action	🔗 Github
`list-account-settings`	List account-level settings (business hours, ticket assignment, satisfaction survey config, access/SSO, auto-merge, auto-split, default integration, etc.).	Action	🔗 Github
`list-custom-fields`	List custom field definitions for tickets or customers.	Action	🔗 Github
`list-customer-custom-field-values`	List all custom field values set on a customer.	Action	🔗 Github
`list-customers`	List customers, optionally filtered by email, name, external ID, language, timezone, view, or channel.	Action	🔗 Github
`list-events`	List account audit-trail events, filterable by object type/ID, event types, user, and creation-date range.	Action	🔗 Github
`list-integrations`	List configured integrations (email senders, HTTP integrations, apps, etc.) on the account.	Action	🔗 Github
`list-jobs`	List bulk-operation jobs (e.g., bulk delete/export), filterable by status and type.	Action	🔗 Github
`list-macros`	List macros (canned response templates), optionally searched, filtered by tags/language/archived state, or ranked by relevance to a ticket/message.	Action	🔗 Github
`list-rules`	List automation rules, optionally searched.	Action	🔗 Github
`list-satisfaction-surveys`	List satisfaction surveys, optionally filtered by ticket.	Action	🔗 Github
`list-tags`	List tags, optionally searched or ordered by usage.	Action	🔗 Github
`list-teams`	List teams.	Action	🔗 Github
`list-ticket-custom-field-values`	List all custom field values set on a ticket.	Action	🔗 Github
`list-ticket-messages`	List messages on a specific ticket	Action	🔗 Github
`list-ticket-tags`	List tags currently applied to a ticket.	Action	🔗 Github
`list-tickets`	List tickets, optionally filtered by customer, view, rule, or specific IDs.	Action	🔗 Github
`list-users`	List users (agents/admins/bots), optionally filtered by role, email, or search term.	Action	🔗 Github
`list-view-items`	List the tickets or customers matching a view’s saved filter.	Action	🔗 Github
`list-views`	List views (saved ticket/customer filter definitions), optionally filtered to system or user-created views.	Action	🔗 Github
`merge-customers`	Merge one customer into another, deleting the source customer.	Action	🔗 Github
`merge-tags`	Merge one or more source tags into a destination tag.	Action	🔗 Github
`remove-ticket-tags`	Remove one or more tags from a ticket.	Action	🔗 Github
`search`	Search across agents, customers, customer channels/profiles, integrations, teams, or tags by a text query.	Action	🔗 Github
`set-customer-data`	Set arbitrary structured JSON data on a customer data field.	Action	🔗 Github
`set-ticket-tags`	Replace a ticket’s full tag list with the given set of existing tags.	Action	🔗 Github
`unarchive-macros`	Unarchive up to 30 macros in one call.	Action	🔗 Github
`update-custom-field`	Update a custom field definition, or deactivate it.	Action	🔗 Github
`update-customer-custom-field-value`	Set a single custom field value on a customer.	Action	🔗 Github
`update-customer-custom-field-values`	Set multiple custom field values on a customer in one call.	Action	🔗 Github
`update-customer`	Update a customer’s fields (name, email, channels, language, timezone, external ID).	Action	🔗 Github
`update-macro`	Update a macro’s name, actions, tags, or language.	Action	🔗 Github
`update-rule-priorities`	Reorder the execution priority of multiple rules in one call.	Action	🔗 Github
`update-rule`	Update a rule’s name, code, or description.	Action	🔗 Github
`update-satisfaction-survey`	Update a satisfaction survey (e.g. record a customer’s score).	Action	🔗 Github
`update-tag`	Rename a tag or change its decoration or description.	Action	🔗 Github
`update-team`	Update a team’s name or description.	Action	🔗 Github
`update-ticket-custom-field-value`	Set a single custom field value on a ticket.	Action	🔗 Github
`update-ticket-custom-field-values`	Set multiple custom field values on a ticket in one call.	Action	🔗 Github
`update-ticket-message`	Update a message’s fields (e.g. body_text/body_html).	Action	🔗 Github
`update-ticket`	Update a ticket’s fields (subject, status, priority, assignee, tags, channel, custom fields, etc.).	Action	🔗 Github
`update-user`	Update a user’s fields (name, email, role, bio, etc.).	Action	🔗 Github
`update-view`	Update a view’s fields.	Action	🔗 Github
`custom-fields`	Sync custom field definitions for both tickets and customers	Sync	🔗 Github
`customers`	Sync customers and their contact channels.	Sync	🔗 Github
`events`	Sync the account’s audit-trail events (ticket/customer/user/tag/rule/etc. lifecycle events).	Sync	🔗 Github
`integrations`	Sync configured integrations (email senders, HTTP integrations, apps, etc.)	Sync	🔗 Github
`macros`	Sync macros (canned response templates).	Sync	🔗 Github
`rules`	Sync automation rules.	Sync	🔗 Github
`satisfaction-surveys`	Sync satisfaction surveys.	Sync	🔗 Github
`tags`	Sync tags.	Sync	🔗 Github
`teams`	Sync teams.	Sync	🔗 Github
`ticket-messages`	Sync messages across all tickets.	Sync	🔗 Github
`tickets`	Sync tickets with their full messages.	Sync	🔗 Github
`users`	Sync users (agents/admins/bots).	Sync	🔗 Github
`views`	Sync views (saved ticket/customer filter definitions), including built-in system views.	Sync	🔗 Github

Access requirements

Pre-Requisites	Status	Comment
Paid dev account	❓
Paid test account	❓
Partnership	❓
App review	❓
Security audit	❓

Setup guide

No setup guide yet.

Need help getting started? Get help in the community.

Contribute improvements to the setup guide by editing this page

Useful links

Contribute useful links by editing this page

Connection configuration in Nango

Gorgias requires a user specific subdomain to run OAuth.

API gotchas

To refresh tokens, you will need to set the offline as part of the scopes when creating an integration.

Contribute API gotchas by editing this page

​Overview

Pre-built tooling

Pre-built integrations

Access requirements

Setup guide

Useful links

API gotchas

​Pre-built tooling

​Others

​Access requirements

​Setup guide

​Useful links

​Connection configuration in Nango

​API gotchas

Overview

Pre-built tooling

Others

Access requirements

Setup guide

Useful links

Connection configuration in Nango

API gotchas