> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Gorgias

> How to set up the Gorgias connector, plus the actions and events that are available.

![Gorgias](https://stackone-logos.com/api/gorgias/filled/svg)

v1.4.0[See changelog](https://docs.stackone.com/connectors/gorgias/changelog.md)

[69 actions](#actions) · [8 events](#events) · 2 auth methods

Customer Support
Ticketing

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [API Key · Connector Profile](https://docs.stackone.com/connectors/gorgias/guides/connector-profile/api-key.md)
>
> Uses your Gorgias email and a personal API key over HTTP Basic authentication. The key inherits the permissions of the u...

> [card] [OAuth 2.0 · Connector Profile](https://docs.stackone.com/connectors/gorgias/guides/connector-profile/oauth-2-0.md)
>
> Requires a Gorgias app created in the Gorgias Partners portal. Access is limited to the scopes the linking user approves...

Optionally, configure receiving Events for Gorgias into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/gorgias/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [API Key · Link Account](https://docs.stackone.com/connectors/gorgias/guides/link-account/api-key.md)

> [card] [OAuth 2.0 · Link Account](https://docs.stackone.com/connectors/gorgias/guides/link-account/oauth-2-0.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

Authentication type

Select all
|
Clear

API Key

OAuth 2.0

No auth methods found

Scopes

Select all
|
Clear

account:read

customers:read

customers:write

integrations:read

integrations:write

macros:read

macros:write

rules:read

rules:write

tags:read

tags:write

tickets:read

tickets:write

users:read

users:write

No scopes found

69 actions

ActionDescriptionRequired scopes

Get Account`gorgias_get_account`

Retrieve the current Gorgias account information including company details and settings

`account:read`

List Settings`gorgias_list_settings`

List account settings matching the given parameters

`account:read`

List Customers`gorgias_list_customers`

Retrieve a paginated list of all customers

`customers:read`

Get Customer`gorgias_get_customer`

Retrieve a single customer by ID

`customers:read`

Create Customer`gorgias_create_customer`

Create a new customer

`customers:write`

Update Customer`gorgias_update_customer`

Update an existing customer

`customers:write`

Delete Customers`gorgias_delete_customers`

Delete one or more customers by their IDs

`customers:write`

Delete Customer`gorgias_delete_customer`

Delete a single customer by ID

`customers:write`

Merge Customers`gorgias_merge_customers`

Merge two customers into one

`customers:write`

Set Customer Data`gorgias_set_customer_data`

Set a customer's data

`customers:write`

List Customer Custom Fields`gorgias_list_customer_custom_fields`

List all custom fields for a customer

`customers:read`

Update Customer Custom Fields`gorgias_update_customer_custom_fields`

Update custom fields for a customer

`customers:write`

Delete Customer Custom Field`gorgias_delete_customer_custom_field`

Delete a customer's custom field value

`customers:write`

List Integrations`gorgias_list_integrations`

Retrieve a paginated list of all integrations

`integrations:read`

Get Integration`gorgias_get_integration`

Retrieve a single integration by ID

`integrations:read`

Create Integration`gorgias_create_integration`

Create a new integration

`integrations:write`

Update Integration`gorgias_update_integration`

Update an existing integration

`integrations:write`

Delete Integration`gorgias_delete_integration`

Delete an integration

`integrations:write`

List Macros`gorgias_list_macros`

Retrieve a paginated list of all macros

`macros:read`

Get Macro`gorgias_get_macro`

Retrieve a single macro by ID

`macros:read`

Create Macro`gorgias_create_macro`

Create a new macro

`macros:write`

Update Macro`gorgias_update_macro`

Update an existing macro

`macros:write`

Delete Macro`gorgias_delete_macro`

Delete a macro

`macros:write`

Archive Macros`gorgias_archive_macros`

Archive multiple macros at once

`macros:write`

Unarchive Macros`gorgias_unarchive_macros`

Unarchive multiple macros at once

`macros:write`

List Messages`gorgias_list_messages`

Retrieve a paginated list of all messages

`tickets:read`

Get Message`gorgias_get_message`

Retrieve a single message by ID

`tickets:read`

Create Message`gorgias_create_message`

Create a new message on a ticket

`tickets:write`

Update Message`gorgias_update_message`

Update an existing message

`tickets:write`

Delete Message`gorgias_delete_message`

Delete a message

`tickets:write`

List Rules`gorgias_list_rules`

Retrieve a paginated list of all rules

`rules:read`

Get Rule`gorgias_get_rule`

Retrieve a single rule by ID

`rules:read`

Create Rule`gorgias_create_rule`

Create a new rule

`rules:write`

Update Rule`gorgias_update_rule`

Update an existing rule

`rules:write`

Delete Rule`gorgias_delete_rule`

Delete a rule

`rules:write`

Update Rules Priorities`gorgias_update_rules_priorities`

Update priorities for multiple rules at once

`rules:write`

List Tags`gorgias_list_tags`

Retrieve a paginated list of all tags

`tags:read`

Get Tag`gorgias_get_tag`

Retrieve a single tag by ID

`tags:read`

Create Tag`gorgias_create_tag`

Create a new tag

`tags:write`

Update Tag`gorgias_update_tag`

Update an existing tag

`tags:write`

Delete Tag`gorgias_delete_tag`

Delete a tag

`tags:write`

Delete Tags`gorgias_delete_tags`

Delete multiple tags at once

`tags:write`

Merge Tags`gorgias_merge_tags`

Merge multiple tags into one

`tags:write`

List Teams`gorgias_list_teams`

Retrieve a paginated list of all teams

`users:read`

Get Team`gorgias_get_team`

Retrieve a single team by ID

`users:read`

Create Team`gorgias_create_team`

Create a new team

`users:write`

Update Team`gorgias_update_team`

Update an existing team

`users:write`

Delete Team`gorgias_delete_team`

Delete a team

`users:write`

List Tickets`gorgias_list_tickets`

Retrieve a paginated list of all tickets

`tickets:read`

Get Ticket`gorgias_get_ticket`

Retrieve a single ticket by ID

`tickets:read`

Create Ticket`gorgias_create_ticket`

Create a new support ticket

`tickets:write`

Update Ticket`gorgias_update_ticket`

Update an existing ticket

`tickets:write`

Delete Ticket`gorgias_delete_ticket`

Permanently delete a ticket

`tickets:write`

Add Tags To Ticket`gorgias_add_tags_to_ticket`

Add tags to an existing ticket

`tickets:write`

Remove Tags From Ticket`gorgias_remove_tags_from_ticket`

Remove tags from an existing ticket

`tickets:write`

List Ticket Tags`gorgias_list_ticket_tags`

List all tags for a ticket

`tickets:read`

Set Ticket Tags`gorgias_set_ticket_tags`

Set a ticket's tags (replaces all existing tags)

`tickets:write`

List Users`gorgias_list_users`

Retrieve a paginated list of all users (agents)

`users:read`

Get User`gorgias_get_user`

Retrieve a single user by ID

`users:read`

Create User`gorgias_create_user`

Create a new user (agent)

`users:write`

Update User`gorgias_update_user`

Update an existing user

`users:write`

Delete User`gorgias_delete_user`

Delete a user

`users:write`

List Views`gorgias_list_views`

Retrieve a paginated list of all views

`tickets:read`

Get View`gorgias_get_view`

Retrieve a single view by ID

`tickets:read`

Create View`gorgias_create_view`

Create a new view

`tickets:write`

Update View`gorgias_update_view`

Update an existing view

`tickets:write`

Delete View`gorgias_delete_view`

Delete a view

`tickets:write`

List View Items`gorgias_list_view_items`

Retrieve tickets in a view

`tickets:read`

Search View Items`gorgias_search_view_items`

Search for items using custom view filters

`tickets:read`

## Events

Tags

Select all
|
Clear

Messages

Tickets

Webhooks

No tags found

8 events

EventDescriptionTags

Ticket Created`gorgias_webhook_ticket_created`

Processes Gorgias ticket-created events fired when a new ticket is created in Gorgias.

TicketsWebhooks

Ticket Updated`gorgias_webhook_ticket_updated`

Processes Gorgias ticket-updated events fired when a ticket is updated (status, tags, custom fields, assignee, priority,...

TicketsWebhooks

Ticket Message Created`gorgias_webhook_ticket_message_created`

Processes Gorgias ticket-message-created events fired when a message (customer reply, agent reply, or internal note) is...

MessagesWebhooks

Ticket Message Failed`gorgias_webhook_ticket_message_failed`

Processes Gorgias ticket-message-failed events fired when an outbound message on a ticket fails to send.

MessagesWebhooks

Ticket Self Unsnoozed`gorgias_webhook_ticket_self_unsnoozed`

Processes Gorgias ticket-self-unsnoozed events fired when a snoozed ticket reopens automatically because its snooze peri...

TicketsWebhooks

Ticket Assignment Updated`gorgias_webhook_ticket_assignment_updated`

Processes Gorgias ticket-assignment-updated events fired when the assignee user or assignee team of a ticket changes.

TicketsWebhooks

Ticket Status Updated`gorgias_webhook_ticket_status_updated`

Processes Gorgias ticket-status-updated events fired when the status of a ticket changes (for example open to closed).

TicketsWebhooks

Ticket Handed Over`gorgias_webhook_ticket_handed_over`

Processes Gorgias ticket-handed-over events fired when a ticket is handed over from automation (such as the Gorgias AI A...

TicketsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.