GOgorgias
Integrations

Retrieve an integration

Changed on
get/api/integrations/{id}

Request

Path parameters

idinteger required

The ID of the integration to retrieve.

Query parameters

include_review_providersboolean
Example:true

Include all matching Yotpo, Okendo and Judge.me integrations in product_review_provider_integrations. Only supported for Shopify integrations. Store domains must match exactly, without normalization. Non-Shopify integrations and missing, blank or non-string shop domains return 404 when enabled. Enabling both include_review_providers and include_shopify_integration returns 404.

include_shopify_integrationboolean
Example:true

Include the matching Shopify integration in shopify_integration. Only supported for Yotpo, Okendo and Judge.me integrations. Store domains must match exactly, without normalization. Unsupported integrations and missing, blank or non-string store domains return 404 when enabled. Enabling both include_review_providers and include_shopify_integration returns 404.

Response

The requested 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",
  "product_review_provider_integrations": [
    {
      "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"
    }
  ],
  "shopify_integration": {
    "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"
  }
}

Changes

  • 3fdfcb5b6678Revision changes
    • info

      added the new optional query request parameter include_review_providers

    • info

      added the new optional query request parameter include_shopify_integration

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status