Webhooks

Um webhook envia um POST para um endereço seu quando algo acontece com os pacotes que você escolher: para iniciar uma implantação, abrir um pull request ou publicar em um canal de chat.

Antes de começar

Você precisa de um endereço https:// que aceite requisições POST, ou da URL de webhook de entrada de um canal do Slack ou do Discord. Os webhooks de uma equipe ficam na organização: sua organização → Webhooks, com as mesmas páginas.

Adicione um webhook

1. Abra Configurações → Webhooks e depois Adicionar um webhook.
2. Digite a URL do payload (1).
3. Escolha o Formato (2): JSON (assinado) para o seu próprio servidor, Slack ou Discord para um canal.
4. Marque os Eventos (3): Novas versões, Avisos de segurança, Pacotes retirados.
5. Escolha os Pacotes (4): os pacotes que você acompanha, os pacotes que você listar pelo nome no Composer ou todos os pacotes (uma entrega por build do repositório).
6. Selecione Adicionar webhook (5).

Para webhooks JSON, a página mostra em seguida o segredo de assinatura uma única vez: copie-o para o seu servidor.

Verifique uma entrega JSON

Cada entrega JSON traz o cabeçalho X-MeteorGPL-Signature: sha256=<HMAC-SHA256 of the body with your secret>. Calcule o mesmo HMAC sobre o corpo bruto e compare antes de confiar no payload. O corpo indica o evento e, por pacote, o nome no Composer, o título, o tipo, as novas versões, um link e o comando de instalação.

Seus webhooks

Cada webhook mostra seu endereço e formato com a situação: Ativo, Pausado ou Desativado após falhas (1); depois, seus eventos e pacotes (2).

• Enviar um teste (3) envia imediatamente uma entrega ping.
• Pausar e Ativar interrompem e retomam as entregas; Remover exclui o webhook.
• Entregas recentes (4) mostra cada entrega com o resultado, o status HTTP que seu servidor respondeu e o número de tentativas; Entregar novamente repete uma delas.

Uma entrega que falha é tentada de novo mais tarde: seis tentativas no total, distribuídas ao longo de cerca de 15 horas. Depois de 20 falhas seguidas, o webhook é desativado e você é avisado; corrija o endpoint e selecione Ativar.