Skip to main content
Webhooks de saída enviam eventos do workspace para sistemas externos, como ferramentas internas, automações, filas, chatops ou plataformas de observabilidade. Use Console > Webhooks para criar, testar, ativar, desativar, editar e acompanhar entregas.

​
Quando usar

Use webhooks quando:
  • um sistema externo precisa reagir a eventos da Acrity;
  • uma automação interna deve receber notificações;
  • você precisa alimentar observabilidade, auditoria ou dashboards;
  • integrações via API polling não são desejáveis.
Use Console > API Keys quando o sistema externo precisar consultar dados ativamente.

​
Quem pode acessar

Admins de workspace normalmente gerenciam webhooks.

​
Campos principais

​
Criar um webhook

1

Abrir webhooks

Acesse Console > Webhooks.
2

Criar novo

Escolha Novo webhook.
3

Informar destino

Preencha nome, URL, método e content type.
4

Selecionar eventos

Escolha os eventos que devem acionar o webhook.
5

Configurar segurança

Adicione headers necessários e habilite HMAC quando o destinatário puder validar assinatura.
6

Testar

Use o teste ou a prévia da tela antes de ativar em produção.
7

Salvar

Salve e acompanhe as primeiras entregas.

​
Headers e segredos

Use headers para enviar tokens, identificadores ou informações exigidas pelo destino. Boas práticas:
  • marque como secreto qualquer header que contenha token ou segredo;
  • não coloque segredos no nome do webhook;
  • prefira rotação de tokens no sistema destinatário;
  • remova headers que não são usados;
  • documente internamente o dono do endpoint.

​
HMAC

HMAC permite que o sistema destinatário valide que o payload veio da Acrity e não foi alterado em trânsito. Use HMAC sempre que o destino suportar verificação de assinatura. Ao habilitar:
  1. Gere ou informe um segredo forte.
  2. Configure o mesmo segredo no sistema destinatário.
  3. Teste uma entrega.
  4. Rejeite payloads sem assinatura válida no destino.

​
Body template

O body template personaliza o corpo enviado. Use quando o destino espera um formato específico. Recomendações:
  • comece com payload simples;
  • valide com a prévia antes de salvar;
  • evite incluir dados sensíveis desnecessários;
  • mantenha compatibilidade com o sistema destinatário;
  • versione mudanças importantes do lado receptor.

​
Testar entrega

Antes de ativar um webhook crítico:
  • use a ação de teste da tela;
  • confirme status de resposta do destino;
  • verifique logs do sistema receptor;
  • valide assinatura HMAC quando habilitada;
  • revise headers e content type;
  • confirme que o payload esperado chegou.

​
Histórico de entregas

O detalhe do webhook pode exibir histórico de entregas. Use esse histórico para investigar:
  • sucesso ou falha de envio;
  • status retornado pelo destino;
  • tempo de resposta;
  • payload de teste ou entrega quando exibido pela tela;
  • erros de conexão, TLS ou validação.

​
Ativar e desativar

Desative um webhook quando:
  • o destino está em manutenção;
  • o endpoint foi substituído;
  • há suspeita de segredo exposto;
  • a integração está gerando ruído;
  • você precisa pausar entregas temporariamente.
Reative apenas depois de validar o destino.

​
Problemas comuns

​
Segurança

Webhooks podem enviar dados operacionais para fora da Acrity. Configure apenas destinos confiáveis e revise periodicamente quais eventos estão ativos. Detalhes sobre tratamento de dados ficam em Segurança > Tratamento de dados.