Criação de webhooks

Sobre a criação de webhooks

Você pode criar webhooks para se inscrever em eventos específicos em GitHub que ocorrem em um repositório, organização, conta GitHub Marketplace, conta GitHub Sponsors, ou GitHub App.

Para obter mais informações sobre os diferentes tipos de webhooks, confira Tipos de webhooks.

Para obter uma lista completa de eventos de webhooks, confira Eventos e cargas de webhook.

Criando um webhook de repositório

Você pode criar um webhook para assinar eventos que ocorrem em um repositório específico. Você deve ser proprietário de um repositório ou ter acesso de administrador no repositório para criar webhooks nesse repositório.

Você pode usar a interface web GitHub ou a REST API para criar um webhook para repositório. Para obter mais informações sobre como usar a API REST para criar um webhook de repositório, confira Pontos de extremidade da API REST para webhooks de repositório.

1. Em GitHub, acesse a página principal do repositório.

2. No nome do repositório, clique em Settings. Caso não consiga ver a guia "Configurações", selecione o menu suspenso , clique em Configurações.

   

3. Na barra lateral esquerda, clique em Webhooks.

4. Clique em Adicionar webhook.

5. Em "URL de carga", digite a URL na qual você gostaria de receber cargas.

6. Opcionalmente, selecione o menu suspenso Tipo de conteúdo e clique em um formato de dados no qual o conteúdo do webhook será recebido.

   • application/json entregará o conteúdo JSON diretamente como o corpo da solicitação POST.
   • application/x-www-form-urlencoded enviará o conteúdo JSON como um parâmetro de formulário chamado payload.

7. Opcionalmente, em "Segredo", digite uma cadeia de caracteres para usar como chave secret. Você deve escolher uma cadeia de caracteres aleatória de texto com alta entropia. Você pode usar o segredo do webhook para limitar as solicitações recebidas apenas àquelas originadas de GitHub. Para saber mais, confira Validação de entregas de webhooks.

8. Em "Em quais eventos você gostaria de disparar este webhook?", selecione os eventos de webhook que você deseja receber. Você só deve se inscrever nos eventos de webhook de que necessita.

9. Se você escolher Deixe-me selecionar eventos individuais, selecione os eventos que deseja que disparem o webhook.

10. Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.

11. Clique em Adicionar webhook.

Depois de criar um novo webhook, GitHub enviará um evento simples ping para informar que você configurou o webhook corretamente. Para saber mais, confira Eventos e cargas de webhook.

Criar um webhook de uma organização

Você pode criar um webhook para assinar eventos que ocorrem em uma organização específica. Você deve ser proprietário de uma organização para criar webhooks nela.

Você pode usar a interface web GitHub ou a API REST para criar um webhook de organização. Para obter mais informações sobre como usar a API REST para criar um webhook da organização, confira Pontos de extremidade de API REST para webhooks da organização.

1. No canto superior direito de qualquer página em GitHub, clique na sua imagem de perfil.
2. Clique em Suas organizações.
3. À direita da organização, clique em Configurações.
4. Na barra lateral esquerda, clique em Webhooks.
5. Clique em Adicionar webhook.
6. Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
7. Opcionalmente, selecione o menu suspenso Tipo de conteúdo e clique em um formato de dados no qual o conteúdo do webhook será recebido.
   • application/json entregará o conteúdo JSON diretamente como o corpo da solicitação POST.
   • application/x-www-form-urlencoded enviará o conteúdo JSON como um parâmetro de formulário chamado payload.
8. Opcionalmente, em "Segredo", digite uma cadeia de caracteres para usar como chave secret. Você deve escolher uma cadeia de caracteres aleatória de texto com alta entropia. Você pode usar o segredo do webhook para limitar as solicitações recebidas apenas àquelas originadas de GitHub. Para saber mais, confira Validação de entregas de webhooks.
9. Em "Em quais eventos você gostaria de disparar este webhook?", selecione os tipos de webhooks que você gostaria de receber. Você só deve se inscrever nos eventos de webhook de que necessita.
10. Se você escolher Deixe-me selecionar eventos individuais, selecione os eventos que dispararão o webhook.
11. Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
12. Clique em Adicionar webhook.

Depois de criar um novo webhook, GitHub enviará um evento simples ping para informar que você configurou o webhook corretamente. Para saber mais, confira Eventos e cargas de webhook.

Criando um GitHub Marketplace webhook

Você pode criar um webhook para se inscrever em eventos relacionados a um app que você publicou em GitHub Marketplace. Somente o proprietário do aplicativo ou um gerente do aplicativo pode criar um webhook GitHub Marketplace.

1. Navegue até a GitHub Marketplace sua página de anúncio.
2. Ao lado da listagem GitHub Marketplace da qual você deseja ver as entregas de webhook, clique em Gerenciar listagem.
3. Na barra lateral, clique em Webhook.
4. Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
5. Opcionalmente, selecione o menu suspenso Tipo de conteúdo e clique em um formato de dados no qual o conteúdo do webhook será recebido.
   • application/json entregará o conteúdo JSON diretamente como o corpo da solicitação POST.
   • application/x-www-form-urlencoded enviará o conteúdo JSON como um parâmetro de formulário chamado payload.
6. Opcionalmente, em "Segredo", digite uma cadeia de caracteres para usar como chave secret. Você deve escolher uma cadeia de caracteres aleatória de texto com alta entropia. Você pode usar o segredo do webhook para limitar as solicitações recebidas apenas àquelas originadas de GitHub. Para saber mais, confira Validação de entregas de webhooks.
7. Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
8. Clique em Criar webhook.

Depois de criar um novo webhook, GitHub enviará a você um evento ping simples para informar que você configurou o webhook corretamente. Para saber mais, confira Eventos e cargas de webhook.

Criando um GitHub Sponsors webhook

Você pode criar um webhook para se inscrever em eventos relacionados aos seus patrocínios. Somente o proprietário da conta patrocinada pode criar webhooks de patrocínio para essa conta. Para obter mais informações sobre o evento no qual um webhook de patrocínio está inscrito, consulte o evento de webhook sponsorship.

1. No canto superior direito de qualquer página, clique na imagem do seu perfil e em Your sponsors.
2. Ao lado da conta da qual você deseja criar um webhook, clique em Painel.
3. Na barra lateral esquerda, clique em Webhooks.
4. Clique em Adicionar webhook.
5. Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
6. Opcionalmente, selecione o menu suspenso Tipo de conteúdo e clique em um formato de dados no qual o conteúdo do webhook será recebido.
   • application/json entregará o conteúdo JSON diretamente como o corpo da solicitação POST.
   • application/x-www-form-urlencoded enviará o conteúdo JSON como um parâmetro de formulário chamado payload.
7. Opcionalmente, em "Segredo", digite uma cadeia de caracteres para usar como chave secret. Você deve escolher uma cadeia de caracteres aleatória de texto com alta entropia. Você pode usar o segredo do webhook para limitar as solicitações recebidas apenas àquelas originadas de GitHub. Para saber mais, confira Validação de entregas de webhooks.
8. Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
9. Clique em Criar webhook.

Criando webhooks para um GitHub App

O proprietário de um GitHub App pode inscrever o aplicativo para receber eventos de webhook e receber notificações sempre que certos eventos ocorrerem. Se o proprietário do aplicativo tiver designado algum gerente de aplicativo para um GitHub App, os gerentes de aplicativo também poderão inscrever o aplicativo em eventos de webhook. Para saber mais, confira Usando webhooks com aplicativos GitHub.

Cada GitHub App tem um webhook. Você pode configurar o webhook ao registrar um GitHub App, ou pode editar a configuração do webhook para um registro GitHub App existente.

Para obter mais informações sobre como configurar um webhook ao registrar um GitHub App, consulte Registrando um aplicativo GitHub.

Para configurar um webhook para um registro existente GitHub App:

1. No canto superior direito de qualquer página do GitHub, clique na foto do seu perfil.

2. Acesse as configurações da sua conta.

   • Para um aplicativo de propriedade de uma conta pessoal, clique em Configurações.
   • Para um aplicativo de propriedade de uma organização:
     1. Clique em Suas organizações.
     2. À direita da organização, clique em Configurações.

3. Na barra lateral esquerda, clique em Developer settings.

4. Na barra lateral esquerda, clique em GitHub Apps .

5. Ao lado do GitHub App que você deseja configurar o webhook, clique em Editar.

6. Em "Webhook", selecione Ativo.

7. Em "URL do webhook", digite a URL na qual você gostaria de receber conteúdo.

8. Opcionalmente, em "Segredo do webhook", digite uma cadeia de caracteres para usar como chave secret. Você deve escolher uma cadeia de caracteres aleatória de texto com alta entropia. Você pode usar o segredo do webhook para limitar as solicitações de entrada apenas às originadas em GitHub. Para saber mais, confira Validação de entregas de webhooks.

9. Selecione Salvar alterações.

10. Na barra lateral, clique em Permissões e eventos.

11. Os eventos de webhook específicos que você pode selecionar no registro do GitHub App são determinados pelo tipo de permissões selecionado para seu aplicativo. Primeiro, você precisará selecionar as permissões que deseja que seu aplicativo tenha e depois assinar o aplicativo em eventos de webhook relacionados a esse conjunto de permissões.

    Nas seções "Permissões do repositório", "Permissões da organização" e "Permissões da conta", selecione as permissões necessárias para os eventos aos quais seu aplicativo se inscreverá. Para saber mais, confira Escolhendo permissões para um aplicativo GitHub. Para obter mais informações sobre as coisas a serem consideradas ao alterar as permissões, consulte Modificando um GitHub App registro.

12. Em "Assinar eventos", selecione os eventos de webhook que você gostaria que seu GitHub App recebesse.

13. Selecione Salvar alterações.

Você também pode usar a API REST para criar um webhook para um GitHub App. Para saber mais, confira Pontos de extremidade da API REST para GitHub App webhooks.

Leitura adicional

• Sobre webhooks
• Lidar com entregas de webhook