Pular para o conteúdo principal

Webhooks

Webhooks são notificações automáticas. Quando algo acontece no RuleForge (uma revisão aprovada, uma versão publicada, uma regressão que falhou), o produto avisa o sistema que você escolher — Slack, Microsoft Teams, um ticket do Jira, uma automação interna, qualquer ferramenta que aceite receber notificações por URL.

Quando usar​

Use webhooks para:

  • avisar o time em um canal de chat quando uma versão é publicada;
  • abrir um ticket automaticamente quando uma regressão falha;
  • notificar um sistema interno quando uma revisão precisa de atenção;
  • disparar uma automação sempre que um feedback novo chega.

Criar um webhook​

  1. Abra Configurações → Integrações → Webhooks.
  2. Clique em Novo webhook.
  3. Informe a URL de destino (o sistema que vai receber a notificação).
  4. Dê uma descrição curta para você identificar depois.
  5. Escolha quais eventos devem disparar a notificação.
  6. Opcionalmente, informe um segredo — ele permite que o sistema de destino verifique que a notificação realmente veio do RuleForge.
  7. Salve.

Eventos disponíveis​

Os eventos são agrupados por assunto. Os principais:

  • Validação e testes: quando uma validação ou log test termina, com sucesso ou falha.
  • Regressão: quando uma regressão é executada e o resultado é conhecido.
  • Revisão: quando uma revisão é criada, aprovada, rejeitada ou tem mudanças solicitadas.
  • Versão: quando uma versão é criada, publicada ou tem falha na publicação.
  • Feedback: quando alguém envia feedback para a sua organização.
  • Chaves de API: quando uma chave é criada ou revogada (útil para trilhas de segurança).

A lista completa e sempre atualizada está em Eventos de webhook.

URLs aceitas​

Para proteger sua organização, o RuleForge aceita apenas URLs públicas com http ou https. URLs locais ou de redes privadas são bloqueadas — isso impede que um webhook mal configurado alcance endereços internos sensíveis.

Entrega e tentativas​

  • Toda notificação fica registrada no histórico do webhook, com o resultado (sucesso ou erro).
  • Se o destino estiver indisponível temporariamente, o RuleForge tenta novamente antes de desistir.
  • Você pode abrir o histórico para entender falhas específicas e reenviar manualmente quando necessário.

Erros comuns​

O webhook não disparou​

Confira, na ordem:

  1. Se o evento está marcado nas opções do webhook.
  2. Se o fluxo que deveria disparar o evento realmente aconteceu (por exemplo, uma versão chegou a ser publicada?).
  3. Se o plano da sua organização inclui integrações.
  4. Se o sistema de destino está acessível publicamente.

O destino rejeita a notificação​

Confirme se o segredo configurado no webhook é o mesmo que o sistema de destino está usando para validar as notificações.

Não consigo salvar a URL​

Você provavelmente informou uma URL local ou privada. Use o endereço público do sistema de destino.