> For the complete documentation index, see [llms.txt](https://help.konnektive.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.konnektive.com/konnektive-crm/admin-setup/plugins/data-sources/gorgias.md).

# Gorgias

This article provides a guide on how to connect your Gorgias account with your Konnektive CRM.

* [Step 1: Obtain Gorgias API Credentials](#step-1-obtain-gorgias-api-credentials)
* [Step 2: Setup the CRM Plugin](#step-2-setup-the-crm-plugin)
* [Step 3: Verify that the Integration and Widget were successfully created.](#step-3-verify-that-the-integration-and-widget-were-successfully-created)
* [Step 4: Verify the Macros were successfully created.](#step-4-verify-the-macros-were-successfully-created)

{% hint style="info" %}
Gorgias Konnektive Integration Documentation can be found [here](https://docs.gorgias.com/ecommerce-integrations/konnektive)
{% endhint %}

***

### Step 1: Obtain Gorgias API Credentials <a href="#step-1-obtain-gorgias-api-credentials" id="step-1-obtain-gorgias-api-credentials"></a>

#### Navigate to **Settings → REST API** to obtain these credentials. <a href="#navigate-to-settings-rest-api-to-obtain-these-credentials" id="navigate-to-settings-rest-api-to-obtain-these-credentials"></a>

<figure><img src="/files/A7tcumYkmOe0Y0X5EdK7" alt=""><figcaption></figcaption></figure>

#### **Be sure to save/copy all fields as they will be required for the CRM setup.** <a href="#be-sure-to-save-copy-all-fields-as-they-will-be-required-for-the-crm-setup" id="be-sure-to-save-copy-all-fields-as-they-will-be-required-for-the-crm-setup"></a>

### Step 2: Setup the CRM Plugin <a href="#step-2-setup-the-crm-plugin" id="step-2-setup-the-crm-plugin"></a>

#### Navigate to **Admin** → **Plugins** → **Data Sources** and click on the green “**+Activate**” button on the Gorgias tile <a href="#navigate-to-admin-plugins-data-sources-and-click-on-the-green-activate-button-on-the-gorgias-tile" id="navigate-to-admin-plugins-data-sources-and-click-on-the-green-activate-button-on-the-gorgias-tile"></a>

&#x20;

<figure><img src="/files/VMVz50MiseAPjUD8jNiV" alt=""><figcaption></figcaption></figure>

&#x20;

#### **baseUrl** **-** your Gorgias Base API Url used to make requests to Gorgias’ API. <a href="#baseurl-your-gorgias-base-api-url-used-to-make-requests-to-gorgias-api" id="baseurl-your-gorgias-base-api-url-used-to-make-requests-to-gorgias-api"></a>

#### **userName** **-** your Gorgias REST API username as it shows in Gorgias. <a href="#username-your-gorgias-rest-api-username-as-it-shows-in-gorgias" id="username-your-gorgias-rest-api-username-as-it-shows-in-gorgias"></a>

#### **apiKey** **-** your Gorgias API key (required) <a href="#apikey-your-gorgias-api-key-required" id="apikey-your-gorgias-api-key-required"></a>

#### **IntegrationId -** read-only value that represents the Id of the Gorgias integration. <a href="#integrationid-read-only-value-that-represents-the-id-of-the-gorgias-integration" id="integrationid-read-only-value-that-represents-the-id-of-the-gorgias-integration"></a>

&#x20;

<figure><img src="/files/9UpDCZGj1UK3Xy60rPtY" alt=""><figcaption></figcaption></figure>

&#x20;

&#x20;

#### Once the plugin is activated you should now see a new HTTP Integration and also a few macros to be used with this integration inside of Gorgias.  <a href="#once-the-plugin-is-activated-you-should-now-see-a-new-http-integration-and-also-a-few-macros-to-be-u" id="once-the-plugin-is-activated-you-should-now-see-a-new-http-integration-and-also-a-few-macros-to-be-u"></a>

&#x20;

### Step 3: Verify that the Integration and Widget were successfully created. <a href="#step-3-verify-that-the-integration-and-widget-were-successfully-created" id="step-3-verify-that-the-integration-and-widget-were-successfully-created"></a>

**Integrations can be found in Settings → General → Integrations. You should see an HTTP integration named “Konnektive Integration”.**

<figure><img src="/files/CUpHuseBOluThMdWzAOc" alt=""><figcaption></figcaption></figure>

**The Konnektive Integration pulls orders from the CRM based on email address used in the ticket.**&#x20;

**If the customer exists the widget on the right will populate with the customer’s order data. Please see below.**

<figure><img src="/files/SWgJ9PaXDZyjH5kgY2Ex" alt=""><figcaption></figcaption></figure>

### Step 4: Verify the Macros were successfully created. <a href="#step-4-verify-the-macros-were-successfully-created" id="step-4-verify-the-macros-were-successfully-created"></a>

**Macros can be found in Settings → Automation → Macros. Once on the Macro page, you should see 11 Konnektive macros.**&#x20;

<figure><img src="/files/XJcNuN14IBtVTAeF4WwI" alt=""><figcaption></figcaption></figure>

&#x20;

**Konnektive Full Refund** - Allows for a Gorgias rep to issue a refund for a particular order.

**Konnektive Partial Refund** - Allows for a Gorgias rep to issue a partial refund for a particular order.

**Konnektive Shipping Address Change** - Allows for a Gorgias rep to change shipping address details tied to an order.

**Konnektive Billing Address Change** - Allows for a Gorgias rep to change billing address details tied to an order.

**Konnektive Cancel Order** - Allows for a Gorgias rep to cancel an order. Can issue full refunds.

**Konnektive Customer Note** - Allows for a Gorgias rep to add a note to a customer record in the CRM.

**Konnektive Customer Update** - Allows for a Gorgias rep to update info on a CRM customers record.

**Konnektive Cancel Subscription** - Allows for a Gorgias rep to cancel a CRM Subscription.

**Konnektive Pause Subscription** - Allows for a Gorgias rep to pause a CRM Subscription.

**Konnektive Update Subscription Bill Cycle** - Allows for a Gorgias rep to update a CRM Subscription.

**Konnektive Update Subscription Products** - Allows for a Gorgias rep to update a CRM Subscription.

{% hint style="info" %}
A note on Gorgias Operations. If a value in a text box is defaulted to 0, it is a true/false value. Enter 0 for false, 1 for true.
{% endhint %}

{% hint style="warning" %}
Troubleshooting: If the Gorgias Widget, or any macro, is accidentally deleted, delete the Gorgias plugin and repeat these steps to restore them.
{% endhint %}