Now that we understand the basics of webhooks, let's go through the process of building out our own webhook-powered integration. In this tutorial, we'll create a repository webhook that will be responsible for listing out how popular our repository is, based on the number of issues it receives per day.
Creating a webhook is a two-step process. You'll first need to set up what events your webhook should listen to. After that, you'll set up your server to receive and manage the payload.
Você pode usar a API REST para gerenciar o repositório, a organização e os webhooks de aplicativo. Você pode listar entregas de webhook para um webhook ou obter e reenviar 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:
Exposing localhost to the internet
For the purposes of this tutorial, we're going to use a local server to receive webhook events from GitHub.
First of all, we need to expose our local development environment to the internet so GitHub can deliver events. We'll use ngrok to do this.
Note: Alternatively, you can use webhook forwarding to set up your local environment to receive webhooks. For more information, see "Receiving webhooks with the GitHub CLI."
ngrok is available, free of charge, for all major operating systems. For more information, see the ngrok download page.
After installing ngrok, you can expose your localhost by running ./ngrok http 4567 on the command line. 4567 is the port number on which our server will listen for messages. You should see a line that looks something like this:
Forwarding http://7e9ea9dc.ngrok.io -> 127.0.0.1:4567
Make a note of the *.ngrok.io URL. We'll use it to set up our webhook.
Setting up a webhook
You can install webhooks on an organization or on a specific repository.
Somente integrantes com privilégios de proprietário de uma organização ou privilégios de administrador de um repositório podem manage webhooks for an organization. Para obter mais informações, confira "Funções em uma organização".
To set up a webhook, go to the settings page of your repository or organization. From there, click Webhooks, then Add webhook.
Alternatively, you can choose to build and manage a webhook through the Webhooks API.
Webhooks require a few configuration options before you can make use of them. We'll go through each of these settings below.
Payload URL
Observação: os webhooks do GitHub atualmente não dão suporte ao IPv6, mas irão no futuro. O ponto de extremidade da API REST /meta retorna intervalos IPv6 para habilitar essa transição.
A URL do conteúdo é a URL do servidor que receberá as solicitações POST do webhook.
Since we're developing locally for our tutorial, we'll set it to the *.ngrok.io URL, followed by /payload. For example, http://7e9ea9dc.ngrok.io/payload.
Content type
Os webhooks podem ser entregues usando diferentes tipos de conteúdo:
- O tipo de conteúdo
application/jsonfornecerá o conteúdo JSON diretamente como o corpo da solicitaçãoPOST. - O tipo de conteúdo
application/x-www-form-urlencodedenvia o conteúdo JSON como um parâmetro de formulário chamadopayload.
Selecione a mais adequada às suas necessidades. For this tutorial, the default content type of application/json is fine.
Secret
A definição de um segredo de webhook permite que você garanta que as solicitações POST enviadas para a URL do conteúdo sejam provenientes do GitHub. Ao definir um segredo, você receberá os cabeçalhos X-Hub-Signature e X-Hub-Signature-256 na solicitação POST do webhook. Para obter mais informações sobre como usar um segredo com um cabeçalho de assinatura para proteger suas cargas de webhook, confira "Securing your webhooks".
SSL verification
Se sua "URL da carga" for uma site seguro (HTTPS), você terá a opção de definir as configurações de verificação SSL. Se a sua "URL de carga " não for segura (HTTP), o GitHub não exibirá esta opção. Por padrão, o GitHub verifica o certificado SSL do seu site ao entregar as cargas de webhook. A verificação SSL ajuda a garantir que as cargas de hook sejam entregues no seu ponto de extremidade da URL de forma segura. Você tem a opção de desabilitar o SSL, mas recomendamos manter a opção Habilitar a verificação de SSL selecionada.
Active
By default, webhook deliveries are "Active." You can choose to disable the delivery of webhook payloads by deselecting "Active."
Events
Events are at the core of webhooks. These webhooks fire whenever a certain action is taken on the repository, which your server's payload URL intercepts and acts upon.
A full list of webhook events, and when they execute, can be found in the webhooks API reference.
Since our webhook is dealing with issues in a repository, we'll click Let me select individual events and then Issues. Make sure you select Active to receive issue events for triggered webhooks. You can also select all events using the default option.
When you're finished, click Add webhook.
Now that you've created the webhook, it's time to set up our local server to test the webhook. Head on over to Configuring Your Server to learn how to do that.
Wildcard event
To configure a webhook for all events, use the wildcard (*) character to specify the webhook events. When you add the wildcard event, we'll replace any existing events you have configured with the wildcard event and send you payloads for all supported events. You'll also automatically get any new events we might add in the future.
Ping event
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.
For more information about the ping event webhook payload, see the ping event.