Skip to main content

Esta versão do GitHub Enterprise será descontinuada em 2023-01-18. Nenhum lançamento de patch será feito, mesmo para questões críticas de segurança. Para obter melhor desempenho, segurança aprimorada e novos recursos, atualize para a última versão do GitHub Enterprise. Para obter ajuda com a atualização, entre em contato com o suporte do GitHub Enterprise.

We've recently moved some of the REST API documentation. If you can't find what you're looking for, you might try the new Branches, Collaborators, Commits, Deploy Keys, Deployments, GitHub Pages, Releases, Metrics, Webhooks REST API pages.

Webhooks

A API de webhooks permite que você crie e gerencie webhooks para seus repositórios.

Os webhooks de repositório permitem que você receba conteúdo POST HTTP sempre que determinados eventos acontecem em um repositório. As APIs REST do webhook permitem que você gerencie o repositório, a organização e os webhooks do aplicativo. Você pode usar essa API para listar entregas de webhook para um webhook ou obter e entregar novamente uma entrega individual para um webhook, que pode ser integrado a um aplicativo ou serviço externo. Você também pode usar a API REST para alterar a configuração do webhook. Por exemplo, você pode modificar a URL da carga, tipo de conteúdo, verificação de SSL e segredo. Para obter mais informações, consulte:

Caso deseje configurar um só webhook para receber eventos de todos os repositórios da sua organização, confira nossa documentação da API para Webhooks da organização.

Além da API REST, o GitHub também pode servir como um hub PubSubHubbub para repositórios.

Receber Webhooks

Para que GitHub Enterprise Server envie cargas de webhook, seu servidor deve ser acessível pela internet. É altamente recomendável o uso de SSL para que possamos enviar cargas criptografadas por HTTPS.

Cabeçalhos de webhook

GitHub Enterprise Server enviará ao longo de vários cabeçalhos de HTTP para diferenciar entre tipos de evento e identificadores de carga. Confira Cabeçalhos de webhook para ver detalhes.

PubSubHubbub

O GitHub também pode servir como um hub PubSubHubbub para todos os repositórios. O PSHB é um simples protocolo de publicação/assinatura que permite o registro de servidores para receber atualizações quando um tópico é atualizado. As atualizações são enviadas com uma solicitação HTTP do tipo POST para uma URL de chamada de retorno. As URLs dos tópicos dos pushes de um repositório do GitHub estão neste formato:

https://github.com/{owner}/{repo}/events/{event}

O evento pode ser qualquer evento de webhook disponível. Para obter mais informações, confira "Eventos e cargas do webhook".

Formato da resposta

O formato padrão é o que os ganchos de pós-recebimento existentes devem esperar: um corpo JSON enviado como o parâmetro payload em um POST. Você também pode especificar o recebimento do corpo JSON bruto com um cabeçalho Accept ou uma extensão .json.

Accept: application/json
https://github.com/{owner}/{repo}/events/push.json

URLs de chamada de retorno

As URLs de retorno de chamada podem usar o protocolo http://.

# Send updates to postbin.org
http://postbin.org/123

Assinar

O ponto de extremidade PubSubHubbub do GitHub é: http(s)://HOSTNAME/api/v3/hub. Uma solicitação bem-sucedida com o curl parece como:

curl -u "user" -i \
  http(s)://HOSTNAME/api/v3/hub \
  -F "hub.mode=subscribe" \
  -F "hub.topic=https://github.com/{owner}/{repo}/events/push" \
  -F "hub.callback=http://postbin.org/123"

Solicitações do PubSubHubbub podem ser enviadas várias vezes. Se o hook já existe, ele será modificado de acordo com a solicitação.

Parâmetros

NomeTipoDescrição
hub.modestringObrigatório. subscribe ou unsubscribe.
hub.topicstringObrigatório. A URI do repositório do GitHub a ser assinada. O caminho precisa estar no formato /{owner}/{repo}/events/{event}.
hub.callbackstringA URI para receber as atualizações do tópico.
hub.secretstringUma chave de segredo compartilhado que gera uma assinatura de hash do conteúdo de saída do texto. Você pode verificar se um push veio do GitHub comparando o corpo bruto da solicitação com o conteúdo de X-Hub-Signature ou X-Hub-Signature-256 cabeçalhos. Veja a documentação do PubSubHubbub para obter mais detalhes.