Integrations connect Gorgias with external services (e.g. Gmail, Shopify, chat systems).

There are official Gorgias integrations that can be found in the Integrations page in the helpdesk and there are custom HTTP integrations.

Most integrations use HTTP APIs.

Integration properties

id

int32

ID of the integration.

created_datetime

ISO 8601 datetime

When the integration was created.

deactivated_datetime

ISO 8601 datetime

When the integration was deactivated.

description

string

Description about the integration.

http

object

Only available for HTTP integrations, defines the configuration of the integration.

name

string

Name of the integration. Usually the email address, Facebook page name, etc.

type

string

Type of integration.

updated_datetime

ISO 8601 datetime

When the integration was last updated.

user

object

User which created this integration.

uri

string

URI of the integration.

Integration example object

{
  "id": 123,
  "created_datetime": "2021-01-07T13:00:00.123456",
  "http": {
    "id": 987,
    "url": "https://company.com/api/customers?email={{ticket.customer.email}}",
    "method": "GET",
    "headers": {
      "x-api-key": "abcdef12345"
    },
    "form": {
      "hello": "world",
      "ticket_id": "{{ticket.id}}"
    },
    "request_content_type": "application/json",
    "response_content_type": "application/json",
    "triggers": {
      "ticket_created": true,
      "ticket_updated": true,
      "ticket_message_created": true
    }
  },
  "name": "My HTTP integration",
  "type": "http",
  "updated_datetime": "2021-01-07T13:00:00.123456",
  "uri": "/api/integrations/123/"
}