Skip to main content

Authorization

Follow this guide to create a new Gorgias credential that will allow Nexla to authenticate to and exchange data with your Gorgias account.
gorgias_api_auth.png

Gorgias

Prerequisites​

To connect Nexla to Gorgias, you need your Gorgias helpdesk domain and an API key. Gorgias uses HTTP Basic Authentication: your email address serves as the username and an API key serves as the password.

Locate Your Gorgias API Credentials​

Your Gorgias helpdesk subdomain and API key are both available in your Gorgias account settings.

  1. Sign in to your Gorgias helpdesk at https://{your-domain}.gorgias.com.

  2. Click the Settings icon in the bottom-left corner of the navigation sidebar.

  3. In the Settings menu, navigate to Account > REST API.

  4. Under API Access & Credentials, you will find:

    • Base API URL — The base URL for API calls, in the format https://{your-domain}.gorgias.com/api/. Copy the subdomain portion (the part before .gorgias.com) — this is your Gorgias Domain value.

    • Username — Your Gorgias account email address. This is used as the username for HTTP Basic Authentication.

    • Password (API Key) — Click Create API Key to generate a new API key. The key is displayed immediately after creation.

Important

Your API key grants full access to your Gorgias account data. Copy the key immediately after creation and store it in a secure location. Once you navigate away from the page, the key cannot be retrieved again — you would need to reset and regenerate it.

Resetting your API key immediately invalidates the previous key. Any existing integrations using the old key will stop working until they are updated with the new key.

Each API key is associated with the specific user account that created it and inherits that user's permissions. Requests made with a key will act on behalf of that user. For best results, generate the API key using an account with the appropriate permissions for the data operations Nexla will perform.

For additional details about API credentials, refer to the Gorgias REST API documentation and the Gorgias Access Tokens guide.

Create a Gorgias Credential​

  • To create a new Gorgias credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used to provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Authentication Settings​

  1. Enter your Gorgias helpdesk subdomain in the Gorgias Domain field. This is the subdomain portion of your Gorgias helpdesk URL — for example, if your helpdesk URL is https://mystore.gorgias.com, enter mystore.

  2. Enter the email address associated with your Gorgias account in the Username field. This is the same email you use to sign in to your Gorgias helpdesk and serves as the username for HTTP Basic Authentication.

  3. Enter your Gorgias API key in the Password field. This is the key you generated in the Prerequisites section above. Gorgias uses this key as the password component of HTTP Basic Authentication for all API requests.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.