Navegar na CentralRegistros de API, Meta e webhooks

Registros de API, Meta e webhooks

Saiba o que cada registro técnico mostra, como ler os códigos de resultado e o que enviar ao suporte para resolver um problema mais rápido.

Atualizado em

Os registros (ou "logs") são o diário técnico do BotoZap: cada pedido feito por um sistema integrado, cada aviso que a Meta mandou e cada aviso que o BotoZap entregou ao seu sistema fica anotado, com data, hora e resultado. No dia a dia você não precisa deles. Eles servem para descobrir por que uma integração falhou e para dar ao suporte as informações certas.

São três telas, todas em Configurações, na parte Desenvolvedores:

  • Logs de API: os pedidos feitos com as suas chaves de API e os avisos recebidos da Meta.
  • Logs da Meta: só os avisos que a Meta mandou para o BotoZap.
  • Logs de webhook: os avisos que o BotoZap entregou (ou tentou entregar) aos seus webhooks.

Antes de começar

  • Qualquer pessoa da equipe pode consultar os registros.
  • Os registros são da conta inteira: o seletor de cliente do topo não muda nada nestas telas.
  • Cada tela mostra os 200 registros mais recentes.

Como ler o código de resultado

A coluna HTTP traz um número de três dígitos que resume o resultado:

  • 2xx (200, 201...): deu certo.
  • 4xx (400, 401, 403, 404, 422...): o pedido foi recusado por um problema nele mesmo, como chave errada, permissão que falta ou dado inválido.
  • 5xx (500, 502...): falhou do lado de quem recebeu o pedido.

Logs de API

Em Configurações › Logs de API, cada linha é um registro:

  • Método e Path: o tipo de pedido e o endereço usado. O desenvolvedor reconhece por aqui o que o sistema tentou fazer, por exemplo enviar uma mensagem.
  • HTTP: o resultado (veja acima).
  • Origem: API para pedidos feitos com as suas chaves; Webhook Meta para avisos que a Meta mandou.
  • Erro: o código de erro do BotoZap, quando houve.
  • Duração: quanto tempo levou.
  • Quando: data e hora, no horário de Brasília.

Acima da lista, o link Investigar por Conta, Cliente, Número e período abre a investigação de envios em Operação.

No alto da lista, filtre por origem (Todas as origens, API, Webhook Meta) e por resultado (Todos, 2xx, 4xx, 5xx). O botão Atualizar busca os registros mais recentes.

Clique numa linha para abrir o detalhe. Além das colunas, ele mostra:

  • Código da aplicação: o código de erro do BotoZap.
  • Código Meta (síncrono): o código de erro que a Meta devolveu na hora, quando houve.
  • Resultado da tentativa, nos envios de mensagem:
    • Aceita; entrega não comprovada: a Meta aceitou a mensagem. A confirmação de entrega chega depois e aparece em Mensagens.
    • Recusa síncrona: a Meta recusou na hora. A mensagem não saiu.
    • Desconhecido; reconciliar antes de reenviar: não dá para saber se a mensagem saiu. Confira em Mensagens antes de mandar de novo, para o contato não receber duas vezes.
  • Ambiente: Produção ou Sandbox.
  • Número (UUID): o código interno do número usado.

Não coletado quer dizer que aquele registro não guardou essa informação.

Logs da Meta

Configurações › Logs da Meta mostra só os avisos que a Meta mandou ao BotoZap: mensagens recebidas pelos seus números e atualizações de entrega. As colunas e o detalhe são os mesmos dos Logs de API.

Use esta tela para confirmar que a Meta está mandando avisos ao BotoZap. Se os contatos estão escrevendo e não aparece nenhum registro recente, os avisos não estão chegando: fale com o suporte.

Logs de webhook

Configurações › Logs de webhook mostra cada aviso que o BotoZap entregou ou tentou entregar aos seus webhooks:

  • Evento: o tipo de aviso, por exemplo uma mensagem recebida ou uma atualização de entrega.
  • Endpoint: o endereço do seu sistema que devia receber.
  • Status:
    • Sucesso: o seu sistema recebeu.
    • Pendente: ainda vai ser enviado ou está esperando a próxima tentativa.
    • Falha: a última tentativa não deu certo. O BotoZap tenta de novo.
    • Esgotado: o BotoZap parou de tentar essa entrega.
  • HTTP: o código que o seu sistema respondeu.
  • Tentativas: quantas vezes o BotoZap tentou.
  • Quando: a última tentativa (ou a criação, se ainda não houve tentativa).

Filtre por Todos, Sucesso, Falha, Pendente ou Esgotado. Clique numa linha para ver Última tentativa, Próxima tentativa, Criado em e o Payload, que é o conteúdo exato do aviso.

Entregas Esgotado podem ser reenviadas em Operação, depois que o sistema de destino estiver funcionando.

Se a tela mostra Nenhuma entrega ainda., ainda não houve aviso para entregar. Cadastre um webhook em Webhooks e use Testar e ativar: o aviso de teste já aparece aqui.

Como ajudar o suporte

Quando algo der errado numa integração, envie ao suporte:

  1. Quando aconteceu (data e hora do registro).
  2. Em Logs de API: Método, Path, HTTP, Código da aplicação, Código Meta (síncrono), Resultado da tentativa e Ambiente.
  3. Em Logs de webhook: Evento, Endpoint, Status, HTTP e Tentativas.
  4. Se for uma mensagem específica, o ID do WhatsApp que aparece nos detalhes da mensagem em Mensagens.

Atenção: nunca envie a chave de API completa nem o segredo do webhook. Evite também copiar o Payload inteiro: ele traz o conteúdo das mensagens e dados dos contatos. Os códigos acima bastam para o suporte localizar o caso.

O suporte fica em Ajuda › Suporte por e-mail e Ajuda › Suporte no WhatsApp.

Problemas comuns

Aparece "Logs indisponíveis. A falha de consulta não indica ausência de chamadas.", "Logs da Meta indisponíveis agora." ou "Logs de webhook indisponíveis agora." A leitura falhou naquele momento; não quer dizer que nada aconteceu. Atualize a página ou volte em alguns minutos.

A integração recebe 401. A chave não foi enviada, está errada, expirou ou foi revogada. Confira o Status dela em Chaves de API.

A integração recebe 403. A chave funciona, mas não tem a permissão para aquela ação, ou é uma chave de Sandbox tentando algo que só existe em Produção. Abra o detalhe do registro e passe o Código da aplicação ao desenvolvedor.

O registro que procuro não aparece. Cada tela mostra só os 200 registros mais recentes. Para investigar envios de mensagem de um período, cliente ou número específico, use Investigar envios em Operação.