Webhooks: o que são e onde ficam
Um webhook é um endereço seu que a Evob chama, com os dados em JSON, quando há um cadastro, um pedido, uma matrícula, um carrinho ou uma assinatura em atraso, e ele é criado na tela Webhooks da plataforma ou da loja.
O que é
Você cadastra o endereço (URL) de um sistema seu. Quando o evento acontece, a Evob envia uma requisição POST para esse endereço, com os dados do evento.
É o caminho para ligar a Evob a um CRM, a uma ferramenta de e-mail, a uma planilha ou a um sistema próprio. A comunicação tem um sentido só: a Evob envia e o seu sistema recebe.
Onde acessar
| Escopo | Caminho | O que alcança |
|---|---|---|
| Plataforma | Plataforma > Configuração > Webhooks | Todas as lojas, ou uma loja e um produto escolhidos |
| Loja | Loja > Configurações > Webhooks | Só aquela loja, ou um produto dela |
Criar, editar e excluir webhooks é liberado para administradores. Quem tem perfil Visualizador vê a lista, sem os botões de editar e excluir.
A tela
A tela Webhooks tem duas abas.
Minhas conexões
Lista os webhooks criados, com:
| Coluna | O que mostra |
|---|---|
| Status | Chave que liga e desliga o webhook |
| Nome do webhook | O nome que você deu |
| Link | O endereço de destino |
| Produto | O produto escolhido, ou Todos |
| Lojas | A loja escolhida, ou Todas (só na tela da plataforma) |
| Eventos | Os eventos marcados |
No alto ficam a busca e o botão Adicionar Webhook. Em cada linha, os ícones de editar e de excluir.
Envios realizados
Mostra um gráfico de Tentativas do Webhook ao longo do tempo, com:
- filtro de período;
- seletor Selecionar webhook, para ver um webhook por vez;
- botão Realizar teste, que dispara um envio de teste para o webhook selecionado.
Veja Envios, falhas e reenvio de webhooks.
Os eventos
| Evento | Quando é enviado |
|---|---|
| Cadastro de novos usuários | Um novo usuário se cadastra na plataforma |
| Pedidos | Uma compra é aprovada |
| Matrículas | Uma matrícula é criada, atualizada ou o aluno conclui o produto |
| Iniciate Checkout | Um carrinho é criado com os dados necessários preenchidos |
| Carrinho abandonado | Um carrinho fica parado pelo tempo que você definir |
| Assinatura em atraso | Uma assinatura fica em atraso |
Os campos de cada um estão em Eventos e campos dos webhooks.
O que você precisa ter
- Um endereço público que aceite POST com corpo em JSON. Endereços internos da sua rede não são alcançados.
https://no endereço.- Alguém que configure o sistema de destino para ler os campos enviados.
O que não existe
- Assinatura criptográfica do envio (HMAC). A proteção é um cabeçalho de autorização. Veja Autenticação dos webhooks.
- Histórico de cada envio na tela, com o conteúdo e a resposta. A aba Envios realizados mostra só a quantidade.
- Botão de reenviar um evento específico.
- Webhook de entrada, para o seu sistema criar ou alterar dados na Evob.
- Eventos de aula assistida, comentário, pesquisa respondida ou estorno.