Criar e testar um webhook
Você cria o webhook no botão Adicionar Webhook, informando nome, endereço de destino, autenticação e eventos, e testa o envio na aba Envios realizados.
Onde acessar
- Plataforma > Configuração > Webhooks, para webhooks de toda a plataforma ou de uma loja escolhida.
- Loja > Configurações > Webhooks, para webhooks só daquela loja.
A criação é liberada para administradores.
Antes de começar
- Tenha o endereço de destino em mãos. Ele precisa ser público, começar com
https://e aceitar POST com corpo em JSON. - Decida quais eventos quer receber. Veja Eventos e campos dos webhooks.
- Se o destino exige autenticação, tenha o valor do cabeçalho de autorização.
💡 Para ver o que a Evob envia antes de ligar o sistema definitivo, use primeiro um endereço de inspeção de requisições e troque depois.
Passo a passo
- Na aba Minhas conexões, clique em Adicionar Webhook. Abre a janela Criar Webhook.
- Preencha o Nome do webhook (obrigatório). Use um nome que diga o destino, como "CRM, pedidos".
- Na tela da plataforma, escolha a loja em Selecione a loja, ou deixe em Todas.
- Em Selecione um produto, escolha um produto ou deixe em Todos. Na tela da plataforma, este campo só libera depois de escolher uma loja.
- Em URL para envio de dados (obrigatório), cole o endereço de destino, no formato
https://exemplo.com. - Em Tipo de autenticação, escolha a forma, se o destino exigir. Veja Autenticação dos webhooks.
- Em Seleciona eventos para enviar, marque os eventos.
- Se marcou Carrinho abandonado, preencha Tempo para o alerta (em minutos). Use Adicionar novo tempo para incluir outros tempos.
- Clique em Salvar.
O webhook nasce ligado. Ele aparece na lista com a chave Status ativa.
Testar
- Vá à aba Envios realizados.
- Em Selecionar webhook, escolha o webhook.
- Clique em Realizar teste.
O teste envia uma requisição para cada evento marcado no webhook. Para o evento de cadastro, o corpo traz dados fictícios. Para os demais eventos, o corpo pode trazer apenas o campo event.
⚠️ A mensagem "Teste realizado com sucesso!" indica que o disparo foi feito. Ela não confirma que o seu sistema aceitou a requisição. Confira sempre no destino se o envio chegou.
Para validar os campos de verdade, faça um caso real: um cadastro de teste, uma compra de teste ou uma matrícula manual.
Ligar, desligar, editar e excluir
| Ação | Como |
|---|---|
| Pausar os envios | Desligue a chave da coluna Status |
| Voltar a enviar | Ligue a chave de novo |
| Mudar endereço, eventos ou autenticação | Ícone de editar, na linha do webhook. Abre a janela Editar Webhook |
| Remover | Ícone de excluir. A tela pergunta "Deseja excluir este webhook?" |
Um webhook ou vários
- Um webhook por destino. Se o CRM e a ferramenta de e-mail têm endereços diferentes, crie um para cada.
- Um webhook por produto, quando cada produto precisa cair em uma lista diferente no destino. O filtro por produto é feito aqui, sem depender de regra no outro sistema.
- Evento de cadastro em um webhook à parte. Ele só existe em webhook sem loja e sem produto.
Erros comuns
"Campo nome é obrigatório" ou "Campo URL é obrigatório"
Preencha os dois campos marcados como obrigatórios.
"Este campo é obrigatório." no tempo do carrinho
Com Carrinho abandonado marcado, o tempo em minutos é obrigatório e precisa ser maior que zero.
"Não consigo escolher o produto"
Na tela da plataforma, escolha primeiro a loja. Com a loja em branco, o campo de produto fica desabilitado.
"O evento Cadastro de novos usuários sumiu"
Ele só aparece quando não há loja nem produto selecionados.
"O teste falhou, confira as configurações do webhook e tente novamente!"
O disparo de teste não pôde ser feito. Confira se o endereço está correto, com https://, e se o destino está no ar.
"Selecione um webhook para testar"
Escolha o webhook no seletor antes de clicar em Realizar teste.