> ## Documentation Index
> Fetch the complete documentation index at: https://docs.withampersand.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Gorgias
## What's Supported
### Supported Actions
This connector supports:
* [Read Actions](/read-actions), including full historic backfill. Please note that incremental read is not supported. A full read of the Gorgias instance will be done for each scheduled read.
* [Write Actions](/write-actions).
* [Proxy Actions](/proxy-actions), using the base URL `https://{{.workspace}}.gorgias.com`.
### Supported Objects
The Gorgias connector supports reading from the following objects:
* [account/settings](https://developers.gorgias.com/reference/list-account-settings)
* [customers](https://developers.gorgias.com/reference/list-customers)
* [custom-fields](https://developers.gorgias.com/reference/list-custom-fields)
* [events](https://developers.gorgias.com/reference/list-events)
* [integrations](https://developers.gorgias.com/reference/list-integrations)
* [jobs](https://developers.gorgias.com/reference/list-jobs)
* [macros](https://developers.gorgias.com/reference/list-macros)
* [rules](https://developers.gorgias.com/reference/list-rules)
* [satisfaction-surveys](https://developers.gorgias.com/reference/list-satisfaction-surveys)
* [tags](https://developers.gorgias.com/reference/list-tags)
* [teams](https://developers.gorgias.com/reference/list-teams)
* [tickets](https://developers.gorgias.com/reference/list-tickets)
* [messages](https://developers.gorgias.com/reference/list-messages)
* [users](https://developers.gorgias.com/reference/list-users)
* [views](https://developers.gorgias.com/reference/list-views)
* [phone/voice-calls](https://developers.gorgias.com/reference/list-voice-calls)
* [phone/voice-call-recordings](https://developers.gorgias.com/reference/list-voice-call-recordings)
* [phone/voice-call-events](https://developers.gorgias.com/reference/list-voice-call-events)
* [widgets](https://developers.gorgias.com/reference/list-widgets)
The Gorgias connector supports writing to the following objects:
* [account/settings](https://developers.gorgias.com/reference/update-account-settings)
* [customers](https://developers.gorgias.com/reference/create-customer)
* [custom-fields](https://developers.gorgias.com/reference/create-custom-field)
* [integrations](https://developers.gorgias.com/reference/create-integration)
* [jobs](https://developers.gorgias.com/reference/create-job)
* [macros](https://developers.gorgias.com/reference/create-macro)
* [rules](https://developers.gorgias.com/reference/create-rule)
* [satisfaction-surveys](https://developers.gorgias.com/reference/create-satisfaction-survey)
* [search](https://developers.gorgias.com/reference/search-1)
* [tags](https://developers.gorgias.com/reference/create-tag)
* [teams](https://developers.gorgias.com/reference/create-team)
* [tickets](https://developers.gorgias.com/reference/create-ticket)
* [users](https://developers.gorgias.com/reference/create-user)
* [views](https://developers.gorgias.com/reference/create-view)
* [widgets](https://developers.gorgias.com/reference/create-widget)
### Example integration
To define an integration for Gorgias, create a manifest file that looks like this: [https://github.com/amp-labs/samples/blob/main/gorgias/amp.yaml](https://github.com/amp-labs/samples/blob/main/gorgias/amp.yaml)
## Before You Get Started
To integrate Gorgias with Ampersand, you will need [a Gorgias Account](https://www.gorgias.com/).
Once your account is created, you'll need to register an OAuth app and obtain the following credentials:
* Client ID
* Client Secret
* Scopes
You will then use these credentials to connect your application to Ampersand.
### Create a Gorgias Developer Account
Here's how you can sign up for a Gorgias account:
* Go to the [Gorgias Developer Sign Up](https://partners.gorgias.com/login) page.
* Sign up using your preferred method.
### Creating a Gorgias OAuth App
Follow the steps below to create a Gorgias OAuth app:
1. Log in to your Gorgias account.
2. Go to **Settings** > **REST API**.
3. In the OAuth 2.0 section, click on **Add new application**.
4. Enter the following details:
1. **Application name:** Choose a name for your integration.
2. **Application Tagline:** Enter a tagline for your integration.
3. **App Icon:** Upload the app icon.
4. **App URL:** Enter the app URL.
5. **Redirect URI:** Enter `https://api.withampersand.com/callbacks/v1/oauth`.
5. Click **Create**.
You will see the **Client ID** and **Client Secret** in the app details. Note these credentials, as you will need them to connect your app to Ampersand.
## Add Your Gorgias App Info to Ampersand
1. Log in to your [Ampersand Dashboard](https://dashboard.withampersand.com).
2. Select the project where you want to create a *Gorgias* integration.
3. Select **Provider Apps**.
4. Select *Gorgias* from the **Provider** list.
5. Enter the previously obtained **Client ID** in the **Client ID** field and the **Client Secret** in the **Client Secret** field.
6. Enter the scopes set for your application in *Gorgias*.
7. Click **Save Changes**.
## Using the connector
To start integrating with Gorgias:
* Create a manifest file using the [example](https://github.com/amp-labs/samples/blob/main/gorgias/amp.yaml).
* Deploy it using the [amp CLI](/cli/overview).
* If you are using Read Actions, create a [destination](/destinations).
* Embed the [InstallIntegration](/embeddable-ui-components#install-integration) UI component.
* Start using the connector
* If your integration has [Read Actions](/read-actions), you'll start getting webhook messages.
* If your integration has [Write Actions](/write-actions), you can start making API calls to our Write API.
* If your integration has [Proxy Actions](/proxy-actions), you can start making Proxy API calls.