Webhooks
Enviar eventos para outro sistema, testar a configuração e consultar as entregas.
Use webhooks para avisar outro sistema quando houver uma mudança em clientes, agendamentos, contas ou produtos. Você precisa de um endereço HTTPS preparado para receber esses eventos. Se outra equipe cuida desse sistema, peça a ela o endereço e os cabeçalhos necessários.
Criar um webhook
- Em "Webhooks", clique em "Novo webhook".
- Preencha "URL do webhook" com o endereço HTTPS do seu sistema.
- Use "Descrição" para reconhecer a configuração depois.
- Em "Eventos", selecione os avisos que deseja enviar. Você pode marcar um grupo inteiro ou escolher eventos individualmente.
- Se o sistema exigir cabeçalhos, clique em "Adicionar cabeçalho" e preencha nome e valor. Você pode cadastrar até 10.
- Mantenha "Ativo" ligado para permitir os envios e clique em "Salvar webhook".
Os eventos podem conter dados do cadastro envolvido. Use apenas um endereço de um sistema em que sua equipe confia.
Editar ou pausar
Clique em "Editar" na configuração desejada. Altere o endereço, a descrição ou os eventos e salve. Para pausar os envios, desligue "Ativo" e salve.
Os cabeçalhos já cadastrados aparecem com valores mascarados. Se você não adicionar novos cabeçalhos, os atuais são mantidos. Se preencher novos cabeçalhos, a nova lista substitui todos os atuais: informe novamente cada cabeçalho que deseja manter. Remover uma linha nova antes de salvar apenas descarta aquela linha.
Enquanto aparecer "Salvando...", aguarde a conclusão. Se o salvamento falhar, o formulário mantém o que você preencheu para corrigir e tentar novamente. "Cancelar" sai sem salvar as alterações.
Testar e consultar entregas
- Mantenha a configuração ativa e clique em "Testar".
- Aguarde o resultado no próprio webhook. O teste envia um aviso de exemplo ao endereço informado.
- Clique em "Entregas" para consultar as tentativas, com evento, data e resultado.
- Abra uma tentativa para consultar os detalhes da requisição e da resposta do seu sistema.
"OK" indica que o sistema confirmou o recebimento. "Falha" ou "Sem resposta" exige conferir o endereço, os cabeçalhos e a disponibilidade do sistema de destino. Um teste sem entrega gerada pode indicar que a configuração está inativa.
Use "Anterior", "Próxima" e "Registros por página" para consultar outras páginas de configurações ou de entregas. Se a consulta falhar, use "Tentar novamente".
Excluir
Clique em "Excluir" na configuração. No diálogo "Excluir webhook", confira a descrição ou o endereço para identificar o destino que será removido. "Cancelar" mantém a configuração. "Excluir" confirma a remoção, que não pode ser desfeita; para usá-la novamente, será necessário criar outra configuração.