Коннектор Gorgias

Подключите хелпдеск Gorgias к Brevo для вовлечения клиентов на основе поддержки, маркетинговых потоков после закрытия тикетов и единой аналитики клиентского опыта через Tajo.

Обзор

СвойствоЗначение
ПлатформаGorgias
КатегорияSupport
Сложность настройкиПростая
Официальная интеграцияНет
Синхронизируемые данныеКлиенты, тикеты, события
Тип APIREST API
АутентификацияAPI Key + Email (Basic Auth)
Базовый URLhttps://{domain}.gorgias.com/api/

Возможности

  • Синхронизация событий тикетов, пересылка событий создания, решения тикетов и CSAT в таймлайны Brevo
  • Обогащение профилей клиентов, синхронизация данных клиентов Gorgias, включая теги и пользовательские поля, в Brevo
  • Постпокупочные кампании, запуск рабочих процессов Brevo после закрытия тикета для follow-up или апселла
  • Отслеживание удовлетворённости, синхронизация результатов CSAT-опросов как атрибутов контактов Brevo
  • Сегментация по тегам, зеркалирование тегов клиентов Gorgias как членства в списках Brevo
  • События макросов и правил, трекинг автоматизированных действий для операционной аналитики

Предварительные требования

Прежде чем начать, убедитесь, что у вас есть:

  1. Аккаунт Gorgias с правами администратора
  2. Поддомен Gorgias (например, yourstore.gorgias.com)
  3. API-ключ и связанный email-адрес
  4. Аккаунт Brevo с доступом к API
  5. Аккаунт Tajo с активной подпиской

Аутентификация

Gorgias использует HTTP Basic Authentication с email аккаунта и API-ключом.

Создание API Key

  1. Войдите в дашборд Gorgias
  2. Перейдите в Settings > REST API
  3. Нажмите Create API Key (или скопируйте существующий ключ)
  4. Запишите базовый URL API: https://{domain}.gorgias.com/api/
Terminal window
# Basic Auth: email как имя пользователя, API-ключ как пароль
curl -X GET "https://yourstore.gorgias.com/api/customers" \
-u "[email protected]:$GORGIAS_API_KEY" \
-H "Content-Type: application/json"

Разрешения API Key

API-ключи Gorgias имеют полный доступ к данным вашего аккаунта. Модель разрешений на основе scope отсутствует. Защищайте API-ключ и регулярно ротируйте его.

Подключение к Tajo

Terminal window
tajo connectors install gorgias \
--domain yourstore.gorgias.com \
--api-key $GORGIAS_API_KEY

Конфигурация

Базовая настройка

connectors:
gorgias:
enabled: true
domain: "yourstore.gorgias.com"
sync:
customers: true
tickets: true
satisfaction_surveys: true
tags: true
lists:
all_support_contacts: 35
satisfied_customers: 36
dissatisfied_customers: 37

Сопоставление полей

Сопоставьте поля клиентов и тикетов Gorgias с атрибутами контактов Brevo:

field_mapping:
# Поля клиента
id: GORGIAS_ID
email: email
name: FIRSTNAME
phone: SMS
# Метрики поддержки
nb_tickets: TICKET_COUNT
last_ticket_date: LAST_SUPPORT_DATE
last_ticket_channel: LAST_SUPPORT_CHANNEL
avg_response_time: AVG_RESPONSE_TIME
# Данные CSAT
last_satisfaction_score: CSAT_SCORE
satisfaction_count: CSAT_RESPONSES
# Пользовательские поля
customer_type: CUSTOMER_TYPE
vip_status: VIP_STATUS

Маппинг событий

event_mapping:
ticket.created: SUPPORT_TICKET_OPENED
ticket.closed: SUPPORT_TICKET_RESOLVED
ticket.reopened: SUPPORT_TICKET_REOPENED
satisfaction_survey.created: CSAT_SURVEY_SENT
satisfaction_survey.responded: CSAT_SUBMITTED
customer.created: SUPPORT_CUSTOMER_CREATED

Эндпоинты API

Tajo интегрируется со следующими эндпоинтами Gorgias REST API:

ЭндпоинтМетодНазначение
/api/customersGETСписок клиентов
/api/customers/{id}GETПолучить клиента
/api/customersPOSTСоздание клиента
/api/customers/{id}PUTОбновление клиента
/api/ticketsGETСписок тикетов
/api/tickets/{id}GETПолучить тикет
/api/tickets/{id}/messagesGETСообщения тикета
/api/tagsGETСписок тегов
/api/satisfaction-surveysGETСписок CSAT-опросов
/api/satisfaction-surveys/{id}GETПолучить опрос
/api/usersGETСписок агентов
/api/integrationsGETСписок интеграций
/api/eventsGETСписок событий
/api/customers/{id}/custom-fieldsGETЗначения пользовательских полей

Примеры кода

Инициализация коннектора

import { TajoClient } from '@tajo/sdk';
const tajo = new TajoClient({
apiKey: process.env.TAJO_API_KEY,
brevoApiKey: process.env.BREVO_API_KEY
});
await tajo.connectors.connect('gorgias', {
domain: 'yourstore.gorgias.com',
apiKey: process.env.GORGIAS_API_KEY
});

Синхронизация клиентов в Brevo

await tajo.connectors.sync('gorgias', {
type: 'incremental',
resources: ['customers'],
since: '2024-01-01',
batchSize: 30
});
const status = await tajo.connectors.status('gorgias');
console.log(status);
// {
// connected: true,
// lastSync: '2024-03-15T17:00:00Z',
// customersCount: 14200,
// ticketsTracked: 28600,
// csatResponses: 3400
// }

Обработка событий тикетов через HTTP-интеграцию

// Gorgias может отправлять HTTP-запросы через правила или HTTP-интеграции
app.post('/webhooks/gorgias', async (req, res) => {
const event = req.body;
await tajo.connectors.handleEvent('gorgias', {
type: 'ticket.updated',
payload: {
ticketId: event.ticket_id,
status: event.status,
customerEmail: event.customer?.email,
channel: event.channel,
tags: event.tags,
satisfaction: event.satisfaction
}
});
res.status(200).send('OK');
});

Постпокупочная кампания

// Запуск follow-up email после закрытия тикета поддержки
tajo.connectors.on('gorgias', 'ticket.closed', async (event) => {
if (event.satisfaction_score >= 4) {
await tajo.campaigns.trigger('post-support-upsell', {
email: event.customer.email,
params: {
agent_name: event.assignee.name,
ticket_subject: event.subject,
resolution_time: event.resolution_time
}
});
}
});

Синхронизация CSAT-данных

// Синхронизация результатов опросов удовлетворённости с атрибутами Brevo
await tajo.connectors.sync('gorgias', {
type: 'incremental',
resources: ['satisfaction_surveys'],
since: '2024-01-01'
});

Ограничения скорости

Gorgias устанавливает лимиты скорости на аккаунт:

Тип лимитаЗначение
Лимит API2 запроса в секунду
Burst-допускДо 5 запросов в короткие периоды
Пагинация30 элементов на страницу (по умолчанию), макс. 100

Стратегия пагинации

Gorgias использует курсорную пагинацию с параметрами cursor и limit. Tajo обрабатывает это автоматически, запрашивая до 100 элементов на страницу для максимальной эффективности.

Gorgias возвращает 429 Too Many Requests при превышении лимитов скорости.

Устранение неполадок

Частые проблемы

ПроблемаПричинаРешение
401 UnauthorizedНедействительный email или API-ключПроверьте учётные данные в Gorgias Settings > REST API
404 Not FoundНеверный эндпоинт или ID ресурсаУбедитесь, что базовый URL API включает ваш поддомен
Отсутствуют клиентыНет email в записиGorgias требует email для совпадения клиентов
Теги не синхронизируютсяТеги не назначены клиентамУбедитесь, что теги на объектах клиентов, а не только на тикетах
Медленная синхронизацияНизкий лимит скоростиGorgias ограничивает до 2 запр./сек; полные синхронизации занимают больше времени

Режим отладки

connectors:
gorgias:
debug: true
log_level: verbose
log_api_calls: true

Проверка подключения

Terminal window
tajo connectors test gorgias
# ✓ API authentication successful
# ✓ Customer list accessible
# ✓ Ticket data readable
# ✓ CSAT surveys available
# ✓ Tags listable

Лучшие практики

  1. Используйте HTTP-интеграции для реального времени, настройте правила Gorgias для отправки HTTP-запросов в Tajo при событиях тикетов
  2. Регулярно синхронизируйте CSAT-данные, используйте оценки удовлетворённости для кампаний повторного вовлечения
  3. Маппируйте теги в сегменты, преобразуйте теги клиентов Gorgias в членство в списках Brevo
  4. Осторожно обрабатывайте пагинацию, при лимите 2 запр./сек планируйте более длительное время синхронизации для больших наборов данных
  5. Связывайте с данными e-commerce, объединяйте данные поддержки Gorgias с данными заказов Shopify в Brevo
  6. Ротируйте API-ключи, поскольку ключи Gorgias имеют полный доступ, регулярно их ротируйте

Безопасность

  • Basic Auth, email и API-ключ через HTTPS
  • Только HTTPS, все API-коммуникации зашифрованы через TLS 1.2+
  • Ключи полного доступа, нет гранулярного ограничения scope (защищайте ключи с осторожностью)
  • IP-разрешение, доступно на старших планах Gorgias
  • Зашифрованное хранение, API-учётные данные зашифрованы при хранении в Tajo
  • Соответствие SOC 2, платформа Gorgias сертифицирована по SOC 2 Type II

Связанные ресурсы

Subscribe to updates

developer-docs

Drop your email or phone number — we'll send you what matters next.

auto-detect
AI-ассистент

Привет! Спрашивайте меня о документации.