Talkz
TalkzCentral de Ajuda
Talkz
TalkzCentral de Ajuda
Trilhas Recursos APIs

Nada encontrado por aqui.

APIs ▸
Pré-Requisitos das APIs Conteúdos sobre APIs ▸
API x Webhook Estrutura de API Bibliotecas
Mensagem ▸
API Digitando… Básica API Digitando…. Pro API Gravando… Básica API Gravando…. Pro API Oficial Digitando Oficial API Mensagem de Texto Básica Pro API Mensagem de Texto via LID Pro API WebChat Mensagem de Texto Webchat API Oficial Mensagem Oficial API Oficial Mensagem Template Oficial API Oficial Mensagem Template sem variável Oficial API Chat Externo Enviar Link Oficial API Chat Externo Mensagem de Texto Oficial API Oficial Template sem variável (Hub) Oficial Hub API Oficial Template com variável (Hub) Oficial Hub API Oficial Template Customizado (Hub) Oficial Hub API Mensagem Interna Todas API Mensagem Registro do Atendimento Todas API Mensagem para Grupos Básica API Mensagem para Grupos Pro API Mensagem de Lista Básica API Mensagem de Lista Pro API Oficial Mensagem de Lista Oficial API Criar Agendamento Todas API Deletar Agendamento Todas API Enviar Contato Básica API Enviar Figurinha Pro Oficial API Listar Figurinhas Todas API Listar Mensagens do Ticket Todas API Listar Mensagens do Ticket sem as Internas Todas API Listar Mensagens por Protocolo Todas API Criar Mensagens Template Meta Oficial API Listar Todas Mensagens Template Meta Oficial API Listar Mensagens Template Meta Oficial API Obter uma Mensagem Template Meta Oficial API Editar Mensagem no Painel Todas
Mídias ▸
API Enviar Imagem por URL Básica API Enviar Imagem por URL Pro API Oficial Enviar Imagem por URL Oficial API Enviar Áudio por URL Básica API Enviar Áudio por URL Pro API Oficial Enviar Áudio por URL Oficial API Enviar Áudio Base64 Pro API Enviar Vídeo por URL Básica API Enviar Vídeo por URL Pro API Oficial Enviar Vídeo por URL Oficial API Enviar Documento por URL Básica API Enviar Documento por URL Pro API Oficial Enviar Documento por URL Oficial API Chat Externo Enviar Arquivo por URL Oficial API Chat Externo Enviar Arquivos Oficial API Enviar Arquivos Básica Pro API WebChat Enviar Arquivos Webchat API Enviar Imagem por URL para Grupos Pro API Enviar Áudio por URL para Grupos Pro API Enviar Vídeo por URL para Grupos Pro API Enviar Documento por URL para Grupos Pro API Enviar Arquivos por URL para Grupos Pro
Ticket ▸
API Criar Ticket Todas API Obter um Ticket Todas API Listar Tickets do Painel Todas API Buscar Tickets por Filtro Todas API Listar Tickets por Tag Todas API Listar Tickets do Contato Todas API Listar Protocolos de um Ticket Todas API Atualizar Ticket Todas API Adicionar Tags ao Ticket Todas API Remover Tags do Ticket Todas API Atualizar Tags do Ticket Todas API Transferir Tickets para um Setor Todas API Transferir Tickets entre Conexões Todas API Encerrar Ticket Todas API Encerrar Ticket em Massa Todas API Encerrar Tickets da Conexão por "Dias de Inatividade" Todas API Encerrar Tickets da Empresa por "Dias de Inatividade" Todas API Apagar Ticket Todas API Janela de Atendimento Todas API Janela de Atendimento pelo Número Todas
Contatos ▸
API Criar Contato Todas API Criar Contato (com validação) Básica Pro API Validar Contato Básica Pro API Obter um Contato Todas API Listar Contatos Todas API Listar Contatos de uma Tag Todas API Atualizar Contato Todas API Deletar TODOS os Contatos Todas
CRM ▸
API Listar Funis Todas API Listar Origens de Venda Todas API Listar Motivos de Perda Todas API Relatório de Anúncios Todas API Listar Leads por Anúncio Todas API Criar Oportunidade Todas API Listar Oportunidades Todas API Obter uma Oportunidade Todas API Atualizar Oportunidade Todas API Mover Oportunidade de Raia Todas API Deletar Oportunidade Todas API Criar Produto Todas API Atualizar Produto Todas API Deletar Produto Todas API Criar Oportunidade V1 Todas API Atualizar Oportunidade V1 Todas API Deletar Oportunidade V1 Todas
PDV ▸
API Criar Pedido Todas API Listar Pedidos Todas API Obter um Pedido Todas API Atualizar Pedido Todas API Confirmar Pedido Todas API Marcar Pedido como Entregue Todas API Cancelar Pedido Todas API Registrar Pagamento do Pedido Todas
Conexões ▸
API Criar Conexão Pro API Status das Conexões Todas API Atualizar Conexão Todas API Reiniciar Conexões Todas API Obter QR Code Pro API Importar Sessão Pro
Setores ▸
API Criar Setor Todas API Listar Setores da Empresa Todas API Atualizar Setor Todas
Equipe ▸
API Criar Usuário Todas API Listar Usuários da Empresa Todas API Atualizar Usuário Todas API Consultar o Status dos Usuários Todas API Atualizar o Status de um Usuário Todas API Derrubar a Sessão de um Usuário Todas API Transferir Carteira de Clientes Todas
Chat Interno ▸
API Criar Conversa no Chat Interno Empresa API Listar Conversas do Chat Interno Empresa API Obter uma Conversa do Chat Interno Empresa API Atualizar Conversa do Chat Interno Empresa API Listar Mensagens do Chat Interno Empresa API Enviar Mensagem no Chat Interno Empresa API Enviar Arquivo no Chat Interno Empresa API Enviar Áudio no Chat Interno Empresa
Rodízios ▸
API Listar Rodízios Todas API Distribuir Atendimento por Rodízio Todas API Próximo Operador do Rodízio do Setor Todas
Fluxos ▸
API Criar Fluxo Todas API Listar Fluxos Todas API Iniciar um Fluxo do Flowbuilder Todas API Iniciar um Fluxo do Typebot Todas
Respostas Rápidas ▸
API Criar Resposta Rápida Todas API Listar Respostas Rápidas Todas
Tags ▸
API Listar Tags da Empresa Todas API Criar Tag Todas API Deletar Tag Todas
Tarefas ▸
API Criar Tarefa Todas API Obter o Status de uma Tarefa Todas API Listar Tarefas Todas API Finalizar Tarefa Todas API Atualizar Tarefa Todas API Deletar Tarefa Todas
Campanhas ▸
API Listar Configurações de Campanha Todas API Atualizar Configurações de Campanha Todas
Botões no WhatsApp ▸
Pré-Requisitos dos Botões API Botão Carrossel Pro API Botão Copia e Cola Básica API Botão Copia e Cola Pro API Botão URL Básica API Botão URL Pro API Oficial Botão URL Oficial API Botão Quick Reply Básica API Botão Quick Reply Pro API Oficial Botão Quick Reply Oficial API Botão Ligação Pro API Botão Pix Pro
E-mail ▸
API Enviar E-mail Todas
Extras ▸
API Listar Configurações da Empresa Todas API Atualizar Configurações da Empresa Todas API Listar Avaliações Todas API Enviar Status de Texto Pro API Enviar Status de Imagem Pro API Enviar Status de Vídeo Pro API Horário de Expediente Todas
Webhooks ▾
Qual Webhook Usar Webhook da Conexão Webhook do Setor Webhook Eventos Webhook Triggers Arquivos no Webhook Webhook do Chat Interno
Precisa de ajuda?
(11) 3741-0340
Webhooks › Webhook do Chat Interno

Webhook do Chat Interno

🔍

🧩 Quer levar para outro sistema o que a equipe combina no Chat Interno — um recado, uma chamada que terminou, a transcrição de uma reunião gravada? O Webhook do Chat Interno avisa o seu sistema na hora, a cada mensagem, reação, conversa ou chamada da equipe.

O Webhook do Chat Interno cobre só as conversas internas da equipe. As conversas com os clientes são avisadas pelos webhooks da Conexão e do Setor.

📋Resumo Prático

➡️ Acesse o menu Chat Interno e clique no ícone Webhook do chat interno, no topo da tela.

➡️ Preencha URL do webhook com o endereço do seu sistema e clique em Salvar.

➡️ Para receber os avisos de uma conversa só, use o campo Webhook desta conversa (opcional), na janela de editar aquela conversa.

Onde ligar

🔘 Webhook do chat interno: o ícone fica no topo da tela do Chat Interno e aparece só para o administrador. A URL do webhook recebe os eventos de todas as conversas do Chat Interno da empresa. Com o campo em branco, nada é enviado. Ao salvar, a tela avisa "Webhook do chat interno salvo".

🔘 Webhook desta conversa (opcional): na janela de editar uma conversa do Chat Interno, recebe os eventos só daquela conversa.

📌 Pela documentação da API da plataforma, a mesma URL no webhook geral e no de uma conversa recebe cada aviso uma vez só.

O endereço precisa aceitar POST com corpo em JSON.

O campo que separa um aviso do outro

Tudo chega no mesmo endereço, e é o acao que diz o que aconteceu no Chat Interno:

acao O que aconteceu
mensagem-criada uma mensagem nova numa conversa — texto, arquivo, áudio, a gravação de uma chamada ou a transcrição e a análise da IA
mensagem-apagada uma mensagem foi apagada
reacao alguém reagiu a uma mensagem ou tirou a reação
chat-criado · chat-alterado · chat-apagado uma conversa foi criada, alterada ou apagada
chamada-iniciada · chamada-encerrada uma chamada da equipe começou ou terminou
gravacao-iniciada · gravacao-concluida · gravacao-transcrita a gravação de uma chamada começou, ficou pronta, ou a IA terminou a transcrição e a análise

Todo aviso do Webhook do Chat Interno traz também:

◽ companyId — a empresa.

◽ chat — o resumo da conversa: id, uuid, title, somenteAvisos (se é um grupo de avisos), ownerId (quem criou) e participantes, com o id e o nome de cada um.

◽ origem — de onde veio o evento: painel (alguém na tela), sistema (a própria plataforma, como nas chamadas e gravações) ou api. Use o origem para o seu sistema não responder ao eco do que ele mesmo mandou pela API.

◽ enviadoEm — a hora em que o aviso foi enviado.

◽ backendURL — o endereço do backend da sua instalação.

Exemplo de payload de Mensagem

{
  "acao": "mensagem-criada",
  "companyId": 8,
  "chat": {
    "id": 9,
    "uuid": "3f2a9c1e-5b7d-4e8a-9c0f-1a2b3c4d5e6f",
    "title": "Time de Vendas",
    "somenteAvisos": false,
    "imagem": null,
    "ownerId": 16,
    "participantes": [
      { "id": 16, "nome": "Ana Supervisora" },
      { "id": 18, "nome": "Bruno Vendas" }
    ]
  },
  "mensagem": {
    "id": 407,
    "chatId": 9,
    "remetente": { "id": 16, "nome": "Ana Supervisora" },
    "message": "Reunião às 15h para fechar a proposta",
    "mediaName": null,
    "mediaUrl": null,
    "quotedMsgId": null,
    "apagada": false,
    "createdAt": "2026-10-27T09:17:53.895Z",
    "mencionados": []
  },
  "origem": "painel",
  "enviadoEm": "2026-10-27T09:17:53.957Z",
  "backendURL": "https://backend_url.com.br"
}

◽ mensagem.remetente — quem escreveu, com id e nome.

◽ mensagem.message — o texto. Numa mensagem com arquivo, mediaName e mediaUrl trazem o nome e o endereço do arquivo.

◽ mensagem.quotedMsgId — a mensagem respondida, quando é uma resposta.

◽ mensagem.mencionados — os ids de quem foi marcado com @.

◽ No mensagem-apagada, mensagem traz só id e chatId, e por diz quem apagou. No reacao, vêm por, o emoji e reacoes, a lista inteira de reações da mensagem: reagir de novo com o mesmo emoji tira a reação.

Exemplo de payload de Chamada

O aviso do fim da chamada traz a duração e quem participou.

{
  "acao": "chamada-encerrada",
  "companyId": 8,
  "chat": {
    "id": 9,
    "uuid": "3f2a9c1e-5b7d-4e8a-9c0f-1a2b3c4d5e6f",
    "title": "Time de Vendas",
    "somenteAvisos": false,
    "imagem": null,
    "ownerId": 16,
    "participantes": [
      { "id": 16, "nome": "Ana Supervisora" },
      { "id": 18, "nome": "Bruno Vendas" }
    ]
  },
  "chamada": {
    "id": 9,
    "tipo": "chat",
    "ticketId": null,
    "iniciadaPorId": 16,
    "iniciadaEm": "2026-10-27T09:18:17.708Z",
    "encerradaEm": "2026-10-27T09:18:37.872Z",
    "duracaoSegundos": 20
  },
  "participantes": [
    { "nome": "Ana Supervisora", "userId": 16, "cliente": false, "entrouEm": "2026-10-27T09:18:17.718Z", "saiuEm": "2026-10-27T09:18:35.314Z" },
    { "nome": "Bruno Vendas", "userId": 18, "cliente": false, "entrouEm": "2026-10-27T09:18:23.945Z", "saiuEm": "2026-10-27T09:18:37.861Z" }
  ],
  "origem": "sistema",
  "enviadoEm": "2026-10-27T09:18:37.893Z",
  "backendURL": "https://backend_url.com.br"
}

◽ chamada.tipo — chat numa chamada do Chat Interno.

◽ chamada.iniciadaPorId — quem começou a chamada.

◽ chamada.duracaoSegundos e chamada.encerradaEm — preenchidos no chamada-encerrada; no chamada-iniciada vêm vazios, e o aviso traz por, com quem começou.

◽ participantes — só no chamada-encerrada: cada pessoa que entrou na chamada, com a hora em que entrou e saiu.

◽ gravacao — nos avisos de gravação. No gravacao-iniciada, gravacao.automatica é false quando alguém tocou em Gravar a chamada. No gravacao-concluida, gravacao.url é o endereço do vídeo, gravacao.duracaoSegundos a duração e gravacao.messageId a mensagem do vídeo na conversa.

◽ transcricao e analise — só no gravacao-transcrita: o texto inteiro da transcrição e da análise.

Como saber que o aviso veio daqui

Pela documentação da API da plataforma, todo aviso do Webhook do Chat Interno traz o cabeçalho X-Chat-Interno-Evento, que repete o evento. Com o Token da Empresa gerado, traz também o cabeçalho X-Assinatura-Chat-Interno: sha256= seguido do HMAC-SHA256 do corpo, calculado com o Token da Empresa como chave.

Para conferir, calcule o HMAC-SHA256 do corpo recebido com o seu Token da Empresa e compare com o valor do cabeçalho. O token não vai no corpo do aviso.

⚠️ O aviso não é repetido. Se o endereço não responder em 15 segundos, aquele aviso se perde. Responda rápido e deixe o processamento pesado para depois.

❔Dúvidas Comuns

O Webhook do Chat Interno avisa as mensagens dos clientes? Não. O Webhook do Chat Interno cobre só as conversas internas da equipe. As mensagens dos clientes são avisadas pelos webhooks da Conexão e do Setor.

Atender uma chamada gera aviso no Webhook do Chat Interno? Não. A chamada gera aviso quando começa (chamada-iniciada) e quando termina (chamada-encerrada). Quem entrou e quando aparece na lista participantes do aviso do fim.

Como evito que o meu sistema responda à própria mensagem no Webhook do Chat Interno? Pelo campo origem. O que o seu sistema manda pela API chega com origem igual a api; ignore esses avisos para não responder ao próprio eco.

A transcrição de uma chamada gravada chega pelo Webhook do Chat Interno? Sim. Quando a IA das gravações termina, chega o aviso gravacao-transcrita, com a transcrição e a análise inteiras. As mensagens que a IA põe na conversa também chegam, como mensagem-criada.

← AnteriorArquivos no Webhook