Sign in

v1

latestOpenAPI 3.1.02026-07-24111290748.0 KB
Integrations

Create an integration

post/api/integrations

Request body

deactivated_datetimestring date-time nullable

When the integration was deactivated.

descriptionstring nullable

Description about the integration.

namestring required

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

type'http' required

Type of integration.

managedboolean

Whether integration is managed by Gorgias.

Example request

{
  "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}}"
    },
    "triggers": {
      "ticket_created": true,
      "ticket_updated": true,
      "ticket_message_created": true,
      "ticket_self_unsnoozed": true,
      "ticket_message_failed": true,
      "ticket_assignee_updated": true,
      "ticket_status_updated": true,
      "ticket_handed_over": true
    },
    "request_content_type": "application/json",
    "response_content_type": "application/json"
  },
  "name": "My HTTP integration",
  "type": "http"
}

Response

The created integration.

idinteger

ID of the integration.

created_datetimestring date-time nullable

When the integration was created.

deactivated_datetimestring date-time nullable

When the integration was deactivated.

descriptionstring nullable

Description about the integration.

namestring required

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

type'http'

Type of integration.

updated_datetimestring date-time nullable

When the integration was last updated.

uristring

URI of the integration.

application_idstring nullable

ID of the related application.

managedboolean

Whether integration is managed by Gorgias.

business_hours_idinteger nullable

The ID of the business hour the phone integration is associated with. If null, the integration will use the default business hours.

Example response

{
  "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,
      "ticket_message_failed": true,
      "ticket_assignee_updated": true,
      "ticket_status_updated": true,
      "ticket_handed_over": 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"
}