API Reference

The Integration object

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

integer

ID of the integration.

ISO 8601 datetime

When the integration was created.

ISO 8601 datetime

When the integration was deactivated.

string | null

Description about the integration.

object

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

string

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

string

Type of integration.

ISO 8601 datetime

When the integration was last updated.

object

User which created this integration.

string

URI of the integration.

string | null

ID of the related application.

boolean

Whether integration is managed by Gorgias.

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",
    "form": {
      "hello": "world",
      "ticket_id": "{{ticket.id}}"
    },
    "triggers": {
      "ticket_created": true,
      "ticket_updated": true,
      "ticket_message_created": true,
      "ticket_self_unsnoozed": true
    },
    "request_content_type": "application/json",
    "response_content_type": "application/json"
  },
  "name": "My HTTP integration",
  "type": "http",
  "updated_datetime": "2021-01-07T13:00:00.123456",
  "uri": "/api/integrations/123/"
}