Conector Gorgias

Conecte seu helpdesk Gorgias ao Brevo para engajamento de clientes orientado por suporte, fluxos de marketing pós-ticket e analytics unificadas de experiência do cliente através do Tajo.

Visão geral

PropriedadeValor
PlataformaGorgias
CategoriaSuporte
Complexidade de configuraçãoFácil
Integração oficialNão
Dados sincronizadosClientes, Tickets, Eventos
Tipo de APIREST API
AutenticaçãoChave API + E-mail (Basic Auth)
URL basehttps://{domain}.gorgias.com/api/

Recursos

  • Sincronização de eventos de ticket - Encaminhe eventos de criação, resolução e CSAT de tickets para as timelines do Brevo
  • Enriquecimento de perfil de cliente - Sincronize dados de cliente do Gorgias, incluindo tags e campos personalizados, para o Brevo
  • Campanhas pós-suporte - Dispare workflows do Brevo após a resolução do ticket para follow-up ou upsell
  • Rastreamento de satisfação - Sincronize resultados de pesquisas CSAT como atributos de contato do Brevo
  • Segmentação baseada em tags - Espelhe tags de clientes do Gorgias como membros de listas do Brevo
  • Eventos de macro e regras - Rastreie ações automatizadas para analytics operacionais

Pré-requisitos

Antes de começar, certifique-se de ter:

  1. Uma conta Gorgias com acesso de admin
  2. Seu subdomínio Gorgias (por exemplo, sualoja.gorgias.com)
  3. Uma chave API e endereço de e-mail associado
  4. Uma conta Brevo com acesso à API
  5. Uma conta Tajo com assinatura ativa

Autenticação

O Gorgias usa HTTP Basic Authentication com seu e-mail da conta e chave API.

Criando uma chave API

  1. Faça login no seu dashboard do Gorgias
  2. Navegue até Settings > REST API
  3. Clique em Create API Key (ou copie a chave existente)
  4. Anote sua URL base da API: https://{domain}.gorgias.com/api/
Terminal window
# Basic Auth: email as username, API key as password
curl -X GET "https://yourstore.gorgias.com/api/customers" \
-u "[email protected]:$GORGIAS_API_KEY" \
-H "Content-Type: application/json"

Permissões da chave API

As chaves API do Gorgias têm acesso total aos dados da sua conta. Não há um modelo de permissão baseado em escopo. Proteja sua chave API e faça rotação regularmente.

Conectando ao Tajo

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

Configuração

Configuração básica

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

Mapeamento de campos

Mapeie campos de cliente e ticket do Gorgias para atributos de contato do Brevo:

field_mapping:
# Customer fields
id: GORGIAS_ID
email: email
name: FIRSTNAME
phone: SMS
# Support metrics
nb_tickets: TICKET_COUNT
last_ticket_date: LAST_SUPPORT_DATE
last_ticket_channel: LAST_SUPPORT_CHANNEL
avg_response_time: AVG_RESPONSE_TIME
# CSAT data
last_satisfaction_score: CSAT_SCORE
satisfaction_count: CSAT_RESPONSES
# Custom fields
customer_type: CUSTOMER_TYPE
vip_status: VIP_STATUS

Mapeamento de eventos

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

Endpoints da API

O Tajo integra-se com os seguintes endpoints da REST API do Gorgias:

EndpointMétodoFinalidade
/api/customersGETListar clientes
/api/customers/{id}GETObter um cliente
/api/customersPOSTCriar um cliente
/api/customers/{id}PUTAtualizar um cliente
/api/ticketsGETListar tickets
/api/tickets/{id}GETObter um ticket
/api/tickets/{id}/messagesGETListar mensagens de ticket
/api/tagsGETListar tags
/api/satisfaction-surveysGETListar pesquisas CSAT
/api/satisfaction-surveys/{id}GETObter uma pesquisa
/api/usersGETListar agentes
/api/integrationsGETListar integrações
/api/eventsGETListar eventos
/api/customers/{id}/custom-fieldsGETObter valores de campos personalizados

Exemplos de código

Inicializar o conector

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
});

Sincronizar clientes para o 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
// }

Tratar eventos de ticket via integração HTTP

// Gorgias can send HTTP requests via Rules or HTTP integrations
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');
});

Campanha pós-resolução

// Trigger a follow-up email after a support ticket is resolved
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
}
});
}
});

Sincronizar dados de CSAT

// Sync satisfaction survey results to Brevo attributes
await tajo.connectors.sync('gorgias', {
type: 'incremental',
resources: ['satisfaction_surveys'],
since: '2024-01-01'
});

Limites de taxa

O Gorgias aplica limites de taxa por conta:

Tipo de limiteValor
Limite de taxa da API2 requisições por segundo
Permissão de rajadaAté 5 requisições em rajadas curtas
Paginação30 itens por página (padrão), máx. 100

Estratégia de paginação

O Gorgias usa paginação baseada em cursor com parâmetros cursor e limit. O Tajo lida com isso automaticamente, solicitando até 100 itens por página para máxima eficiência.

O Gorgias retorna 429 Too Many Requests quando os limites de taxa são excedidos.

Solução de problemas

Problemas comuns

ProblemaCausaSolução
401 UnauthorizedE-mail ou chave API inválidosVerifique as credenciais em Gorgias Settings > REST API
404 Not FoundEndpoint ou ID de recurso inválidoVerifique se a URL base da API inclui seu subdomínio
Clientes ausentesSem e-mail no registroO Gorgias exige e-mail para correspondência de clientes
Tags não sincronizamTags não atribuídas a clientesVerifique se as tags estão em objetos de cliente, não apenas em tickets
Sincronização lentaLimite de taxa baixoO Gorgias limita a 2 req/s; sincronizações completas levam mais tempo

Modo de depuração

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

Testar conexão

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

Melhores práticas

  1. Use integrações HTTP para tempo real - Configure regras do Gorgias para enviar requisições HTTP ao Tajo em eventos de ticket
  2. Sincronize dados CSAT regularmente - Use pontuações de satisfação para impulsionar campanhas de reengajamento
  3. Mapeie tags para segmentos - Traduza tags de clientes do Gorgias em membros de listas do Brevo
  4. Trate a paginação com cuidado - Com limites de 2 req/s, planeje tempos de sincronização mais longos para grandes volumes de dados
  5. Vincule a dados de e-commerce - Combine dados de suporte do Gorgias com dados de pedidos do Shopify no Brevo
  6. Faça rotação das chaves API - Como as chaves do Gorgias têm acesso total, faça rotação periodicamente

Segurança

  • Basic Auth - E-mail e chave API sobre HTTPS
  • Somente HTTPS - Toda comunicação com a API é criptografada via TLS 1.2+
  • Chaves de acesso total - Sem escopo granular (proteja as chaves cuidadosamente)
  • Allowlisting de IP - Disponível em planos superiores do Gorgias
  • Armazenamento criptografado - Credenciais de API criptografadas em repouso no Tajo
  • Conformidade SOC 2 - A plataforma Gorgias é certificada SOC 2 Type II

Recursos relacionados

Subscribe to updates

developer-docs

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

auto-detect
Assistente AI

Olá! Pergunte-me qualquer coisa sobre a documentação.