LogoTalkToMe
Plugins

Webhook

Monitore eventos em tempo real com o Webhook.

O de Webhook permite que você receba notificações automáticas sempre que determinados eventos ocorrerem dentro da sua plataforma, como uma nova mensagem ou a transferência de um atendimento para outro agente ou equipe.

Como configurar o Webhook?

Para configurar o webhook siga os passos abaixo:

Defina a URL

Informe a para a qual os eventos devem ser enviados. Esse é o endpoint que vai receber os dados do evento em formato .

Configure os Headers (opcional)

Caso necessário, adicione headers personalizados, como tokens de autenticação (Authorization, x-api-key, entre outros), para garantir a segurança e a identificação correta nas requisições.

Selecionar os eventos

Escolha os eventos que deseja monitorar:

  • Nova mensagem: Quando uma nova mensagem é enviada em um atendimento.
  • Novo atendimento: Quando um atendimento é iniciado.
  • Finalizado: Quando o atendimento é encerrado.
  • Transferido para equipe: Quando o atendimento é transferido para uma equipe.
  • Transferido para agente: Quando o atendimento é redirecionado para outro agente.
  • Transferido para IA: Quando o atendimento passa a ser gerenciado pela inteligência artificial.
  • Status do usuário: Quando o status do usuário é alterado.

Ativar o Webhook

Clique em "Ativo" para habilitar o Webhook.

Salvar

Clique em para concluir a configuração.

  • Veja um exemplo de Payload do evento finalizar enviado pelo Webhook:
{
"headers": {
  "host": "webhook.exemplo.com.br",
  "user-agent": "python-requests/2.32.3",
  "content-length": "374",
  "accept": "*/*",
  "accept-encoding": "gzip, deflate, br",
  "baggage": "sentry-trace_id=abc123,sentry-sample_rand=0.5,sentry-environment=production,sentry-release=2.0.0,sentry-public_key=examplekey,sentry-transaction=/api/webhook/whatsapp/%7Bphone%7D,sentry-sample_rate=1.0,sentry-sampled=true",
  "content-type": "application/json",
  "sentry-trace": "abc123-def456-1",
  "x-forwarded-for": "192.168.1.100",
  "x-forwarded-host": "webhook.exemplo.com.br",
  "x-forwarded-port": "443",
  "x-forwarded-proto": "https",
  "x-forwarded-server": "traefik",
  "x-real-ip": "192.168.1.100"
},
"params": {},
"query": {},
"body": {
  "event_type": "finish",
  "content": {
    "id": 1234567,
    "thread_id": 123456,
    "tool_call_id": null,
    "action": "finish",
    "data": {
      "ignore_finish_message": true
    },
    "user": {
      "id": "admin_001",
      "name": "Maria Oliveira",
      "role": "admin",
      "status": "active",
      "email": "maria.oliveira@empresa.com.br",
      "image": null
    },
    "created_at": "2025-04-14T21:19:56.786948Z"
  }
},
"webhookUrl": "https://webhook.exemplo.com.br/webhook/1234abcd-5678-efgh-9101-ijklmnopqrst",
"executionMode": "production"
}

Nesta página