Skip to main content

Sobre webhooks

In this article

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ê crie ou configure integrações, como GitHub Apps ou OAuth Apps, que se inscrevem em determinados 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 no em uma organização, em um repositório específico ou em um GitHub App. 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ê se inscrever no evento issues, receberá cargas detalhadas sempre que um problema for aberto, fechado, rotulado etc.

Para ver a lista completa dos eventos de webhook disponíveis e as respectivas cargas, confira "Eventos e cargas de webhook".

Evento de ping

Quando você criar um webhook, enviaremos um evento ping simples para que você saiba que configurou o webhook corretamente. Esse evento não é armazenado, ou seja, não pode ser recuperado por meio do ponto de extremidade da API de Eventos.

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