1. Eventos
Khal Docs
  • Raiz
    • CRM
      • CRM — Overview
      • Genérico (data)
        • CRM - Genérico
        • Listar/filtrar registros (qualquer tabela do CRM)
        • Criar/atualizar registros (qualquer tabela do CRM)
        • Hard-delete (não permitido para tabelas company)
      • Empresas Relacionadas
        • CRM - Empresas relacionadas
        • Listar relacionamentos de uma empresa (ambas as direções)
        • Tipos de relacionamento disponíveis
        • Criar relacionamento entre duas empresas
        • Alterar o tipo do relacionamento
        • Inativar relacionamento (reversível)
        • Excluir relacionamento (hard-delete)
      • Ticket ↔ Empresa
        • CRM - Ticket <-> Empresa
        • Empresas elegíveis para o ticket
        • Vincular / trocar a empresa do ticket
      • Templates
        • CRM - Templates
        • Listar templates do tenant (apenas IDs, sem fields)
        • Detalhe completo do template (com fields)
        • Pesquisa formatada por scope (CRMSearchResult)
      • Empresas do cliente
        • Listar tipos de relacionamento
        • Listar empresas de um cliente
        • Vincular empresa ao cliente
        • Trocar a empresa principal
        • Alterar tipo de relacionamento
        • Inativar vínculo
        • Reativar vínculo
        • Excluir vínculo
    • Workflow
      • Workflow - Overview
      • Tickets
        • Workflow - Tickets
        • Criar ticket com auto-vínculo / criação de customer via contato
        • Detalhe completo do ticket (mensagens, SLA, fases, customer, empresa, business)
        • Criar ticket (básico, com integração CRM opcional)
        • Movimentar ticket entre fases (ou finalizar)
        • Atualizar dados do ticket (nome, descrição, valor)
        • Vincular cliente CRM a um ticket existente
        • Adicionar nota ou mensagem ao ticket
        • Atribuir ou transferir o responsável do ticket
      • Workspaces & Workflows
        • Workflow - Workspaces & Workflows
        • Listar workspaces e workflows acessíveis ao usuário
        • Listar fases de um workflow
        • Listar tickets de uma ou mais fases (paginado)
    • Webhooks
      • Eventos
        • 📨 [Contrato] Evento entregue na sua URL
          POST
        • Catálogo de eventos disponíveis
          GET
      • Assinaturas
        • Listar webhooks cadastrados
        • Criar webhook (o secret aparece UMA única vez)
        • Testar conectividade de uma URL
        • Detalhar webhook
        • Atualizar webhook
        • Ativar/desativar webhook (toggle)
        • Remover webhook (soft delete)
      • Entregas
        • Log de entregas de uma assinatura
        • Reprocessar uma entrega
        • Reprocessar TODAS as entregas com falha
      • Integrações
        • Voz IA (ElevenLabs)
          • Criar ou atualizar a integração de Voz IA
          • Consultar a integração de Voz IA
          • Alterar a integração de Voz IA (secret, toggle, allowlist)
          • Remover a integração de Voz IA
          • Webhook pós-chamada (chamado pelo provedor de voz)
    • Configurações
      • Canais
        • WhatsApp oficial
          • Listar conexões de WhatsApp (a tela Canais › WhatsApp oficial)
          • Listar números disponíveis de uma WABA
          • Criar conexão de WhatsApp oficial
          • Conectar o número oficial (ativar a conexão)
        • Telefonia
          • Anexar gravação de ligação (telefonia de terceiros)
          • Registrar CSAT de ligação
          • Consultar status da gravação enviada
      • Templates
        • WhatsApp oficial
          • Listar templates HSM (a tela Templates › WhatsApp oficial)
          • Criar template HSM (+ Novo modelo)
          • Detalhar template
          • Atualizar template
          • Excluir template
          • Sincronizar templates com a Meta
          • Upload de mídia para o header do template
        • RCS
          • Listar templates de RCS
      • Base de dados
        • Modelo de colunas do CSV
        • Importar base (CSV) para uma tabela do CRM
        • Acompanhar as importações (validar o resultado)
        • Erros de uma importação
        • Exportar os erros em planilha
    • Raiz
      • Workflow
        • Tarefas
          • Criar tarefa
          • Listar tarefas
          • Resumo de tarefas
          • Consultar tarefa
          • Editar tarefa
          • Concluir tarefa
          • Cancelar (excluir) tarefa
          • Silenciar alarme
          • Tarefas do ticket
  • Esquemas
    • LoginRequest
    • FilterOperator
    • WebhookSubscription
    • ClienteEmpresaTipo
    • LoginResponse
    • FilterCondition
    • WebhookSubscriptionResumo
    • ClienteEmpresa
    • Error
    • Pagination
    • WebhookDelivery
    • ErroRegra
    • FilterRequest
    • WebhookEventEnvelope
    • FilterResponse
    • SetMethod
    • SetRequest
    • DeleteRequest
    • SuccessEnvelope
    • ErrorEnvelope
    • Empresa
    • EmpresaResumo
    • EmpresaRelacionadaCreate
    • EmpresaRelacionada
    • TicketInfoResponse
  1. Eventos

📨 [Contrato] Evento entregue na sua URL

POST
/SUA-URL-CADASTRADA
Este NÃO é um endpoint da plataforma — é o contrato do POST que a
plataforma faz na URL que você cadastrou na assinatura.

Envelope#

Todo evento chega como JSON {id, event_id, event_type, timestamp, data}.
id = UUID da entrega (idempotência: re-tentativas REPETEM event_id,
mas trocam id). data segue a convenção {description, snapshot, changes?, context} — snapshot é o objeto no momento do evento e
context traz metadados (ex.: operator_id). No ticket.closed, data
ganha também crm com dados do cliente vinculado.

Validação da assinatura (HMAC-SHA256) — FAÇA ISSO#

A assinatura cobre timestamp.body (proteção contra replay):
Rejeite também timestamps muito antigos (ex.: > 5 min) pra bloquear replay.

O que a plataforma espera de você#

Resposta 2xx em até 10 segundos (timeout). Dica: responda 202 na hora
e processe assíncrono.
Redirects N��O são seguidos.
Sua resposta é registrada no log de entregas (truncada em 4 KB).

Retry#

Falhou (não-2xx, timeout, erro de rede)? Até 5 tentativas com backoff:
1 min → 5 min → 15 min → 1 h → 6 h. Depois disso a entrega fica failed
definitivo — reprocessável via POST /api/v2/webhooks/deliveries/{id}/retry.

Requisição

Parâmetros Header

Parâmetros Bodyapplication/json

Examples

Respostas

🟢200OK
application/json
Qualquer 2xx do SEU servidor marca a entrega como success. Responda rápido (até 10s) — de preferência 202 + processamento assíncrono.
Bodyapplication/json

Request Request Example
Shell
JavaScript
Java
Swift
cURL
curl --location '/SUA-URL-CADASTRADA' \
--header 'X-Digitalk-Signature: sha256=4f02d1a9e8b7c6d5...' \
--header 'X-Digitalk-Timestamp: 1718114400000' \
--header 'X-Digitalk-Event: ticket.created' \
--header 'X-Digitalk-Delivery: 9c8b7a6f-5e4d-3c2b-1a0f-9e8d7c6b5a4f' \
--header 'Content-Type: application/json' \
--data '{
    "id": "9c8b7a6f-5e4d-3c2b-1a0f-9e8d7c6b5a4f",
    "event_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "event_type": "ticket.created",
    "timestamp": 1718114400000,
    "data": {
        "description": "Ticket criado",
        "snapshot": {
            "id": "2d83f114-08a0-4d20-aa09-7e9d3421a0db",
            "name": "Atendimento João",
            "workflow_id": "877784d9-25ac-456c-87b7-2a3e2e97988f",
            "phase_id": "45e57312-9cff-460a-a707-ed509af000f6"
        },
        "context": {
            "operator_id": 1234
        }
    }
}'
Response Response Example
{
    "received": true
}
Modificado em 2026-11-04 02:53:16
Página anterior
Listar tickets de uma ou mais fases (paginado)
Próxima página
Catálogo de eventos disponíveis
Built with