Sobre webhooks

Aprenda os princípios básicos de como os webhooks funcionam para ajudá-lo a criar e configurar integrações.

Os webhooks permitem que você construa ou configure integrações, como Aplicativos do GitHub ou Aplicativos OAuth, que assinam certos eventos no GitHub.com. Quando um desses eventos é acionado, enviaremos uma carga de POST por HTTP POST para a URL de configuração do webhook. Os webhooks podem ser usados para atualizar um rastreador de problemas externo, acionar criações de CI, atualizar um espelho de backup, ou até mesmo fazer uma implantação no seu servidor de produção. A sua imaginação é o único limite.

Os webhooks podem ser instalados em uma organização, em um repositórioespecífico ou em aplicativo GitHub. Uma vez instalado, o webhook será enviado cada vez que ocorrer um ou mais eventos assinados.

Você pode criar até 20 webhooks para cada evento em cada destino de instalação (organização específica ou repositório específico).

Eventos

Ao configurar um webhook, você pode usar a interface do usuário ou API para escolher quais eventos enviarão cargas. Assinar apenas os eventos específicos que pretende gerenciar limita o número de solicitações HTTP para o seu servidor. Você também pode assinar todos os eventos atuais e futuros. Por padrão, os webhooks são apenas inscritos no evento de push. Você pode alterar a lista de eventos assinados a qualquer momento.

Cada evento corresponde a um certo conjunto de ações que podem ocorrer na sua organização e/ou repositório. Por exemplo, se você assinar o evento problemas, você receberá cargas detalhadas toda vez que uma tarefa for aberta, fechada, etiquetada, etc.

Para obter uma lista completa de eventos de webhook disponíveis e suas cargas, consulte "Eventos e cargas de webhook".

Evento de ping

Ao criar um novo webhook, enviaremos um simples evento de ping para informar que você configurou o webhook corretamente. Este evento não é armazenado. Portanto, não é recuperável através do ponto de extremidade da API de Eventos.

Para obter mais informações sobre a carga do webhook do evento de ping, consulte o evento ping.

Esse documento ajudou você?

Política de Privacidade

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.