Criação de webhooks

Sobre a criação de webhooks

Você pode criar webhooks para eventos específicos em GitHub, que ocorrem em um repositório, organização, na conta do GitHub Marketplace, na conta do GitHub Sponsors, ou no 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 do GitHub ou a API REST para criar um webhook de 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.

Em GitHub, acesse a página principal do repositório.
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.
Na barra lateral esquerda, clique em Webhooks.
Clique em Adicionar webhook.
Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
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.
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.
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.
Se você escolher Deixe-me selecionar eventos individuais, selecione os eventos que deseja que disparem o webhook.
Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
Clique em Adicionar webhook.

Depois que você criar um webhook, o GitHub lhe enviará um evento ping simples para que você saiba que 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 do 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.

No canto superior direito de qualquer página do GitHub, clique na imagem do seu perfil.
Clique em Suas organizações.
À direita da organização, clique em Configurações.
Na barra lateral esquerda, clique em Webhooks.
Clique em Adicionar webhook.
Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
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.
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.
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.
Se você escolher Deixe-me selecionar eventos individuais, selecione os eventos que dispararão o webhook.
Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
Clique em Adicionar webhook.

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

Criar um webhook de GitHub Marketplace

Você pode criar um webhook para assinar eventos relacionados a um aplicativo publicado em GitHub Marketplace. Somente o proprietário do aplicativo ou um gerente responsável pelo aplicativo pode criar um webhook do GitHub Marketplace.

Navegue até sua página de anúncios no GitHub Marketplace.
Ao lado da listagem de GitHub Marketplace cujas entregas de webhook você deseja visualizar, clique em Gerenciar listagem.
Na barra lateral, clique em Webhook.
Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
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.
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.
Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
Clique em Criar webhook.

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

Criar um webhook do GitHub Sponsors

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.

No canto superior direito de qualquer página, clique na imagem do seu perfil e em Your sponsors.
Ao lado da conta da qual você deseja criar um webhook, clique em Painel.
Na barra lateral esquerda, clique em Webhooks.
Clique em Adicionar webhook.
Em "URL de carga", digite a URL na qual você gostaria de receber cargas.
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.
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.
Para tornar o webhook ativo imediatamente após adicionar a configuração, selecione Ativo.
Clique em Criar webhook.

Criar webhooks para um GitHub App

O proprietário de um GitHub App pode inscrever o aplicativo em eventos de webhook para receber notificações sempre que determinados eventos ocorrerem. Se o proprietário do aplicativo tiver designado qualquer gerenciador de aplicativos para um GitHub App, os gerentes de aplicativos também poderão inscrever o aplicativo em eventos do 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 editar a configuração do webhook para um GitHub App já registrado.

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

Para configurar um webhook para um registro do GitHub App existente:

No canto superior direito de qualquer página do GitHub, clique na foto do seu perfil.
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.
Na barra lateral esquerda, clique em Developer settings.
Na barra lateral esquerda, clique em GitHub Apps .
Junto ao GitHub App para o qual você deseja configurar um webhook, clique em Editar.
Em "Webhook", selecione Ativo.
Em "URL do webhook", digite a URL na qual você gostaria de receber conteúdo.
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 recebidas apenas àquelas originadas do GitHub. Para saber mais, confira Validação de entregas de webhooks.
Selecione Salvar alterações.
Na barra lateral, clique em Permissões e eventos.
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 o que considerar ao alterar as permissões, confira Modificando um registro do GitHub App.
Em "Inscrever-se em eventos", selecione os eventos de webhook que você deseja que o GitHub App receba.
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 de webhooks do GitHub App.

Leitura adicional

        [AUTOTITLE](/webhooks/about-webhooks)

        [AUTOTITLE](/webhooks/using-webhooks/handling-webhook-deliveries)

Neste artigo