Como validar se um webhook está funcionando?

Os webhooks permitem que a Uappi envie notificações automaticamente para um sistema externo sempre que um evento ocorre na plataforma, como a criação de um pedido, alteração de um produto ou atualização de um cliente.

Neste artigo você aprenderá como verificar se um webhook está configurado corretamente e como validar se ele está funcionando.


O que é um webhook?

Um webhook é um mecanismo que permite à Uappi comunicar automaticamente eventos da loja para outro sistema, como um ERP, middleware ou integrador.

Em vez de consultar constantemente a API para verificar se houve alterações, o sistema externo recebe uma notificação sempre que um evento configurado acontece.

Exemplo: quando um novo pedido é criado, a Uappi envia automaticamente uma requisição para a URL cadastrada no webhook.

Importante: um webhook é considerado entregue com sucesso quando o endpoint retorna o código HTTP 200 (OK).


Antes de iniciar

Antes de realizar qualquer teste, confirme se a configuração do webhook está correta.

Acesse:

Configurações > Integrações > API

Selecione o domínio desejado (Pedidos, Produtos, Clientes, Recuperação de Vendas, entre outros) e verifique:

  • O domínio está habilitado para integração.
  • O webhook está com o status Ativo.
  • A URL configurada é pública e acessível pela internet.
  • O tipo de notificação (Item ou Lote) corresponde ao esperado pelo sistema que receberá os dados.
  • Caso existam filtros (como status de pedido), eles permitem o envio do evento que será utilizado no teste.

Atenção: se alguma dessas configurações estiver incorreta, o webhook poderá não ser disparado mesmo sem apresentar erros.


Como validar um webhook

Passo 1 – Gere um evento

Para que o webhook seja enviado, é necessário provocar um evento correspondente ao domínio configurado.

Veja alguns exemplos:

DomínioEvento para teste
PedidoCriar um pedido ou alterar o status de um pedido
ProdutoAlterar preço, estoque ou status de um produto
ClienteCriar ou atualizar um cliente
Recuperação de VendasGerar um carrinho abandonado
Avise-meSimular um produto voltando ao estoque

Observação: o envio das notificações ocorre conforme a frequência configurada na loja. Por isso, o disparo pode levar alguns minutos.


Passo 2 – Consulte o histórico de notificações

Na configuração do webhook, clique em:

Visualizar últimas notificações enviadas

Verifique:

  • Se existe uma notificação correspondente ao teste realizado.
  • Qual foi o código HTTP retornado pelo endpoint.
  • Se o conteúdo enviado corresponde ao evento gerado.

Como interpretar o resultado

ResultadoSignificado
HTTP 200        O webhook foi entregue com sucesso.
HTTP 400, 401, 404, 500…        A Uappi enviou a requisição, mas o sistema receptor retornou erro.
Nenhuma notificação        O evento não foi gerado, foi bloqueado por filtros ou  ainda aguarda processamento.

Passo 3 – Valide no sistema receptor

Além da confirmação no painel da Uappi, é importante verificar se o sistema que recebe o webhook processou corretamente a requisição.

Confirme se:

  • A requisição chegou ao endpoint configurado.
  • O payload foi recebido corretamente.
  • O processamento esperado foi realizado (por exemplo, sincronização de um pedido).

A validação completa só acontece quando o webhook é entregue com sucesso e o sistema receptor processa a informação corretamente.


Quando a Uappi considera um webhook entregue?

A entrega é considerada bem-sucedida quando o endpoint responde com o código HTTP 200 (OK).

Caso a URL responda com erro em tentativas consecutivas (até 10 falhas), o webhook poderá ser desativado automaticamente para evitar novas tentativas de envio para um endpoint indisponível.

Após corrigir o problema, será necessário reativar o webhook no painel.


Problemas comuns

O webhook está ativo, mas nenhuma notificação é enviada

Verifique:

  • se o domínio está habilitado;
  • se existem filtros impedindo o envio;
  • se o evento utilizado realmente dispara aquele webhook;
  • se já passou o intervalo de processamento configurado.

O webhook foi enviado, mas retornou erro

Quando o histórico apresenta códigos diferentes de HTTP 200, recomenda-se:

  • validar se a URL está correta;
  • confirmar que o endpoint utiliza HTTPS válido;
  • verificar possíveis bloqueios de firewall;
  • confirmar que o endpoint aceita requisições POST com conteúdo JSON;
  • analisar os logs do sistema receptor.

O webhook foi desativado automaticamente

Esse comportamento normalmente ocorre após sucessivas falhas de entrega.

Para resolver:

  1. Corrija o endpoint.
  2. Reative o webhook no painel.
  3. Gere um novo evento de teste.
  4. Confirme se a resposta passou a retornar HTTP 200.

A Uappi informa sucesso, mas o ERP não processa os dados

Nesse cenário, a entrega ocorreu corretamente.

O problema provavelmente está no processamento realizado pelo sistema receptor.

Verifique:

  • regras de importação;
  • autenticação interna;
  • mapeamento dos dados recebidos;
  • logs do ERP ou middleware.

Testando a URL manualmente (opcional)

Caso sua equipe técnica queira validar apenas o endpoint antes de utilizar a Uappi, é possível realizar um teste simples utilizando o comando abaixo:

curl -X POST “https://sua-url-de-webhook” \

  -H “Content-Type: application/json” \

  -d “{\”teste\”:true}” \

  -w “\nHTTP:%{http_code}\n”

Se a resposta não for HTTP 200, recomenda-se corrigir o endpoint antes de realizar novos testes na plataforma.


Como saber se o webhook está funcionando?

Considere o webhook validado quando todos os critérios abaixo forem atendidos:

  • O webhook está ativo e configurado corretamente.
  • Um evento de teste foi executado.
  • O histórico de notificações apresenta retorno HTTP 200.
  • O sistema receptor confirma que recebeu e processou a requisição.

Precisa de ajuda?

Se o webhook continuar sem funcionar após seguir este procedimento, abra um chamado informando:

  • domínio testado (Pedido, Produto, Cliente etc.);
  • data e horário do teste;
  • print do histórico de notificações;
  • código HTTP retornado;
  • URL do webhook (sem credenciais sensíveis);
  • confirmação se o sistema receptor recebeu ou não a requisição.

Essas informações ajudam nossa equipe de suporte a identificar a causa do problema com mais rapidez.

Perguntas frequentes 

O webhook é enviado imediatamente após o evento?

Nem sempre. O envio respeita a frequência configurada na loja, portanto pode levar alguns minutos até que a notificação seja enviada.


O que significa o código HTTP 200?

Significa que o endpoint recebeu a requisição e respondeu com sucesso. Para a Uappi, esse é o indicativo de que o webhook foi entregue corretamente.


Recebi HTTP 500. O problema é da Uappi?

Na maioria dos casos, não. O código HTTP 500 indica que o servidor que recebeu a requisição encontrou um erro durante o processamento.


O webhook aparece como enviado, mas meu ERP não atualizou. O que pode ser?

Isso normalmente indica que a entrega foi realizada com sucesso, mas houve algum problema no processamento interno do ERP ou middleware. Nesse caso, é necessário verificar os logs do sistema receptor.


Meu webhook foi desativado automaticamente. O que devo fazer?

Isso pode acontecer quando o endpoint retorna falhas consecutivas (até 10 tentativas). Corrija o problema na URL, reative o webhook no painel e realize um novo teste.


Posso utilizar uma URL local (localhost)?

Não. A URL do webhook deve ser pública e acessível pela internet para que a Uappi consiga enviar as notificações.


Qual método HTTP é utilizado?

Os webhooks são enviados utilizando o método POST.


O payload é enviado em JSON?

Sim. O conteúdo da requisição é enviado no formato JSON, devendo ser interpretado pelo sistema receptor.


Como saber se o problema está na Uappi ou no meu sistema?

Uma boa forma de identificar é verificar o histórico de notificações:

  • HTTP 200: a Uappi entregou o webhook corretamente. O problema, se existir, provavelmente está no sistema receptor.
  • HTTP diferente de 200: o endpoint retornou erro e deve ser analisado.
  • Sem notificações: verifique a configuração do webhook, filtros e se o evento realmente foi gerado.
Tags
Social Share

Leave a Reply

Your email address will not be published. Required fields are marked *