Chat AGPT
Chat AGPTCentral de Ajuda
Chat AGPT
Chat AGPTCentral 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 Oficial Mensagem Oficial API Oficial Mensagem Template Oficial API Oficial Mensagem Template sem variável Oficial API Modo Alternativo Enviar Link Oficial API Modo Alternativo Mensagem de Texto Oficial API Chat Externo Mensagem de Texto Chat Externo API WebChat Mensagem de Texto Webchat API Facebook Mensagem de Texto Facebook API Instagram Mensagem de Texto Instagram 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 Chat Externo Mensagem de Lista Chat Externo API WebChat Mensagem de Lista Webchat API Facebook Mensagem de Lista Facebook API Instagram Mensagem de Lista Instagram API Enviar Contato Pro 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 Gupshup Mensagem Template Gupshup API RCS Mensagem Template RCS 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 Facebook Enviar Imagem por URL Facebook API Instagram Enviar Imagem por URL Instagram API Enviar Áudio por URL Básica API Enviar Áudio por URL Pro API Oficial Enviar Áudio por URL Oficial API Facebook Enviar Áudio por URL Facebook API Instagram Enviar Áudio por URL Instagram 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 Facebook Enviar Vídeo por URL Facebook API Instagram Enviar Vídeo por URL Instagram API Enviar Documento por URL Básica API Enviar Documento por URL Pro API Oficial Enviar Documento por URL Oficial API Facebook Enviar Documento por URL Facebook API Instagram Enviar Documento por URL Instagram API Modo Alternativo Enviar Arquivo por URL Oficial API Chat Externo Enviar Arquivo por URL Chat Externo API Modo Alternativo Enviar Arquivo Oficial API Chat Externo Enviar Arquivo Chat Externo API Enviar Arquivo Básica Pro API WebChat Enviar Arquivo 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 Arquivo 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
Quadro de Atendimentos ▸
API Criar Quadro Todas API Listar Quadros Todas API Obter um Quadro Todas API Atualizar Quadro Todas API Deletar Quadro Todas API Criar Coluna do Quadro Todas API Atualizar Coluna do Quadro Todas API Reordenar Colunas do Quadro Todas API Deletar Coluna do Quadro Todas API Fixar Atendimento no Topo da Coluna Todas API Listar Atendimentos do Quadro Todas API Mover Atendimento de Coluna Todas API Trocar a Tag do Atendimento no Quadro Todas API Criar Regra Pessoal do Quadro Todas API Listar Regras Pessoais do Quadro Todas API Reordenar Regras Pessoais do Quadro Todas API Criar Regra da Equipe do Quadro Todas API Atualizar Regra do Quadro Todas API Executar as Regras do Quadro Todas API Deletar Regra do Quadro Todas API Listar Regras da Equipe do Quadro Todas API Reordenar Regras da Equipe do Quadro Todas API Listar Usuários do Quadro Todas API Obter os Quadros de um Usuário Todas API Atualizar os Quadros de um Usuário Todas
Respostas Rápidas ▸
API Criar Resposta Rápida Todas API Listar Respostas Rápidas Todas
Agendamentos ▸
API Criar Agendamento Todas API Listar Agendamentos Todas API Obter um Agendamento Todas API Atualizar Agendamento Todas API Deletar Agendamento Todas
Campanhas ▸
API Listar Configurações de Campanha Todas API Atualizar Configurações de Campanha 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
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 Obter uma Tarefa Todas API Finalizar Tarefa Todas API Atualizar Tarefa Todas API Deletar Tarefa Todas API Criar Comentário na Tarefa Todas API Listar Comentários da Tarefa Todas API Anexar Arquivo na Tarefa Todas API Listar Anexos da Tarefa Todas API Deletar Anexo da Tarefa 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 Listar Entregas do Webhook da Conexão 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
Fluxos ▸
API Criar Fluxo Todas API Listar Fluxos Todas API Iniciar um Fluxo do Flowbuilder Todas API Iniciar um Fluxo do Typebot 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 API Gerar Link de Login Automático Empresa
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
Gravações ▸
API Listar Gravações Empresa API Obter uma Gravação Empresa API Obter a Transcrição de uma Gravação Empresa API Pedir a Transcrição de uma Gravação Empresa
Rodízios ▸
API Listar Rodízios Todas API Obter o Relatório de um Rodízio Todas API Distribuir Atendimento por Rodízio Todas API Próximo Operador do Rodízio do Setor Todas
Botões ▸
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 Chat Externo Botão Quick Reply Chat Externo API WebChat Botão Quick Reply Webchat API Facebook Botão Quick Reply Facebook API Instagram Botão Quick Reply Instagram API Botão Ligação Pro API Botão Pix Pro
E-mail ▸
API Enviar E-mail Todas API Listar Contas de E-mail Todas API Listar E-mails Todas API Obter um E-mail Todas
Produtos ▸
API Criar Produto Todas API Listar Produtos Todas API Obter um Produto Todas API Obter um Produto pelo SKU Todas API Atualizar Produto Todas API Deletar Produto Todas API Lançar Movimentação no Estoque Todas API Listar Movimentações do Estoque 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 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 em Preparo Todas API Marcar Pedido como Pronto Todas API Marcar Pedido como Saiu para Entrega Todas API Marcar Pedido como Entregue Todas API Cancelar Pedido Todas API Registrar Pagamento do Pedido Todas API Listar Descontos e Taxas das Formas de Pagamento Todas API Listar Lançamentos do PDV Todas API Obter Relatório do PDV Todas API Listar Categorias de Produto Todas API Listar Setores de Produção Todas API Listar Taxas de Entrega Todas API Cotar Frete Todas API Obter o Resumo do Cliente no PDV Todas API Criar Endereço do Cliente Todas API Importar Endereços do Cliente Todas API Listar Endereços do Cliente Todas API Atualizar Endereço do Cliente Todas API Deletar Endereço do Cliente Todas API Listar Mesas e Comandas Todas API Criar Reserva de Mesa Todas API Listar Reservas de Mesa Todas API Obter uma Reserva de Mesa Todas API Atualizar Reserva de Mesa Todas API Atualizar a Situação de uma Reserva de Mesa Todas
Projetos ▸
API Listar Modelos de Projeto Empresa API Listar Situações dos Projetos Empresa API Criar Projeto Empresa API Listar Projetos Empresa API Obter um Projeto Empresa API Atualizar Projeto Empresa API Deletar Projeto Empresa API Criar Coluna do Projeto Empresa API Atualizar Coluna do Projeto Empresa API Deletar Coluna do Projeto Empresa API Criar Tarefa no Projeto Empresa API Atualizar Tarefa do Projeto Empresa
Consultório ▸
API Obter a Configuração da Agenda do Consultório Empresa API Listar Serviços do Consultório Empresa API Listar Profissionais do Consultório Empresa API Listar Salas do Consultório Empresa API Listar Convênios do Consultório Empresa API Listar Horários Livres do Consultório Empresa API Marcar Consulta Empresa API Buscar Consultas do Contato Empresa API Obter uma Consulta Empresa API Remarcar Consulta Empresa API Atualizar o Status da Consulta Empresa API Criar Paciente Empresa API Buscar Pacientes Empresa API Ligar Paciente a um Contato Empresa
Reservas ▸
API Criar Reserva Todas API Listar Reservas Todas API Obter uma Reserva Todas API Atualizar Reserva Todas API Atualizar a Situação de uma Reserva Todas API Criar Série de Reservas Todas API Obter uma Série de Reservas Todas API Conferir as Datas de uma Série de Reservas Todas API Vender Pacote ao Cliente Todas API Listar Pacotes das Reservas Todas API Obter o Saldo de Pacotes do Cliente Todas API Listar Noites Livres da Diária Todas API Listar Ofertas das Reservas Todas API Listar Recursos das Reservas Todas API Listar Horários Livres das Reservas Todas API Obter a Configuração das Reservas Todas API Obter o Relatório das Reservas 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
FAQ API 👾
Webhooks ▾
Qual Webhook Usar Webhook da Conexão Webhook do Setor Arquivos no Webhook Webhook Eventos Webhook do Chat Interno Webhook de E-mail Webhook do PDV Webhook do Cardápio Digital Webhook de Projetos Webhook do Consultório Webhook das Reservas Webhook Triggers Webhook do Mail Marketing FAQ Webhook 👾
Precisa de ajuda?
(41) 3077-6744
Webhooks › FAQ Webhook

FAQ Webhook

👾
🔍

🧩 As perguntas que mais aparecem na primeira integração por webhook, com a causa de cada uma. Se algo não está chegando, comece por aqui antes de procurar defeito no seu código.

❔Dúvidas Comuns

Configurei o endereço e não chega nada. Confira três coisas, nessa ordem: o seu receptor aceita POST com corpo em JSON; o endereço está completo e acessível de fora da sua rede; e o evento realmente aconteceu no lugar certo — um webhook de Setor só dispara para atendimentos daquele Setor.

Estou recebendo cada evento duas vezes. É quase sempre o webhook da Conexão e o do Setor ligados ao mesmo tempo. Quando o atendimento está no Setor configurado, os dois disparam. Se só o Setor interessa, deixe o campo da Conexão vazio. Os dois avisos do mesmo fato chegam com o mesmo eventoId: guarde os códigos já tratados e descarte o que se repetir.

Recebi o aviso mas o campo mensagem veio vazio. O cliente mandou um arquivo. Arquivo gera dois avisos seguidos: o primeiro chega no formato de mensagem, com o campo trazendo só uma indicação do tipo (Áudio, o nome do arquivo quando é PDF, ou vazio quando é imagem ou vídeo). O segundo, com acao igual a fila-data, é o que traz a mídia.

Como sei se a mensagem foi enviada ou recebida? Pelo campo fromMe: false é do cliente para você, true é de você para o cliente. Não use o campo name para isso — ele traz o nome do cliente quando a mensagem é recebida e o celular dele quando é enviada, e essa troca é o que mais confunde quem está começando.

Meu código lê acao e o aviso de tag não é reconhecido. No aviso de tag da Conexão e do Setor a chave se chama action, não acao. Trate os dois nomes.

O que são webhookUrl e executionMode no fim dos exemplos? Não são da plataforma: é o envelope que a ferramenta de automação acrescenta ao registrar a chamada que recebeu. O que a plataforma envia é o conteúdo de body.

Como descubro se veio texto, áudio ou figurinha? Pelo nome da chave dentro de body.msg.message. Texto do celular vem como conversation e texto do WhatsApp Web como extendedTextMessage; os demais são audioMessage, imageMessage, videoMessage, documentMessage, reactionMessage, stickerMessage, contactMessage e locationMessage.

O aviso é reenviado se o meu sistema estiver fora do ar na hora? Não conte com isso. Trate cada aviso como entrega única: receba, registre o quanto antes e só depois processe. No Webhook da Conexão, cada aviso traz a sequencia, o número da entrega naquele endereço, que sobe de 1 em 1: quando um número falta, o aviso se perdeu, e ele pode ser buscado de novo pela API, a partir do último número recebido, por até 7 dias.

Como sei quem fez o que gerou o aviso — o cliente, o chatbot ou a minha integração? Pelo campo origemDoEvento: contato é o cliente, chatbot é o chatbot do Setor, sistema são as mensagens automáticas da plataforma e api é uma chamada da sua integração. É ele que separa o aviso de algo que o seu próprio sistema fez pela API.

O payload traz dados sensíveis? Traz. Os avisos de Conexão e de Setor carregam o token da Conexão (em token_origin, connection_token e ticketData.whatsapp.token), além do nome e do telefone do contato. Aponte apenas para endereços seus, sob HTTPS, e não registre o corpo inteiro em log que terceiros possam ler.

Qual webhook eu uso para quê? O da Conexão para espelhar tudo que passa por um canal. O de Setor quando só um time interessa. O de Eventos para o que não é mensagem de cliente — nota interna, tag, status de usuário e CRM. E o Trigger quando o sentido é o contrário: um sistema de fora avisando a plataforma para iniciar um fluxo.

O Webhook Trigger não inicia o fluxo. Três campos são obrigatórios no envio do sistema externo: nome, celular e email. Faltando um, não há para quem enviar nem com que nome tratar. Confira também se o Setor selecionado no Trigger é o que tem o fluxo vinculado.

Cliquei em Atualizar Dados no Trigger e não apareceu payload nenhum. O botão mostra a última requisição recebida — ele não cria uma. Faça o sistema externo disparar de verdade e clique depois.

As variáveis do Trigger não são substituídas no fluxo. Elas se escrevem entre sinais de porcentagem: %nome%, %celular%, %email%, %extra1%. E só existem depois de apontadas para os campos do payload, no passo de definir as variáveis.

Preciso de webhook ou de API? Se o seu sistema estaria perguntando de tempos em tempos "aconteceu algo novo?", é webhook. Se ele precisa de um dado no momento em que quiser, é API. Na maioria das integrações os dois convivem: o webhook avisa, e a API completa o que o aviso não trouxe.

← AnteriorWebhook do Mail Marketing