Criar webhooks

Sobre a criação de webhooks

Você pode criar webhooks para assinar eventos específicos no GitHub que ocorrem em um repositório, organização, conta GitHub Enterprise, 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".

Criar um webhook de um 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 da Web 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, consulte "Pontos de extremidade da API REST para webhooks de repositório".

No sua instância do GitHub Enterprise Server, navegue até a página principal do repositório.
Abaixo do nome do repositório, clique em Configurações. 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 conteúdo", digite a URL em você gostaria de receber conteúdo.
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 obter mais informações, 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 novo webhook, GitHub lhe enviará um evento ping simples para que você saiba que configurou o webhook corretamente. Para obter mais informações, 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 da Web GitHub ou a API REST para criar um webhook da organização. Para obter mais informações sobre como usar a API REST para criar um webhook da organização, consulte "Pontos de extremidade de API REST para webhooks da organização".

No canto superior direito de qualquer página do sua instância do GitHub Enterprise Server, clique na foto de 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 conteúdo", digite a URL em você gostaria de receber conteúdo.
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 obter mais informações, 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 novo webhook, GitHub lhe enviará um evento ping simples para que você saiba que configurou o webhook corretamente. Para obter mais informações, confira "Eventos e cargas de webhook".

Criar um webhook global para um GitHub Enterprise

Os proprietários de empresas podem criar um webhook global para assinar eventos que ocorrem em sua empresa.

Você pode usar a interface da Web da GitHub ou a API REST para criar um webhook global. Para obter mais informações sobre como usar a API REST para criar um webhook global, consulte "Pontos de extremidade da API REST para webhooks globais".

No canto superior à direita de GitHub Enterprise Server, clique na sua foto do perfil e clique em Configurações da empresa.
Na barra lateral da conta corporativa, clique em Configurações.
Em " Configurações", clique em Ganchos.
Clique em Adicionar webhook.
No campo "URL de conteúdo", digite a URL em que deseja receber o conteúdo.
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 obter mais informações, confira "Validação de entregas de webhooks".
Opcionalmente, se a URL de conteúdo for HTTPS e você não quiser que o GitHub Enterprise Server verifique os certificados SSL ao fornecer o conteúdo, selecione Desabilitar em "Verificação de SSL". Leia as informações sobre a verificação de SSL e clique em Desabilitar. Entendi que os meus webhooks podem não estar seguros.

Aviso: a verificação SSL ajuda a garantir que o conteúdo do gancho seja entregue com segurança. Não é recomendável desabilitar a verificação SSL.
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.

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 uma organização tiver designado gerentes de aplicativos para um GitHub App de propriedade da organização, os gerentes de aplicativos também poderão inscrever o aplicativo em eventos de webhook. Para obter mais informações, confira "Usar 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 existente do GitHub App.

Para obter mais informações sobre como configurar um webhook ao registrar um GitHub App, confira "Registrar 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 Configurações do desenvolvedor.
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 de GitHub. Para obter mais informações, 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 obter mais informações, confira "Escolhendo permissões para um Aplicativo GitHub". Para obter mais informações sobre o que considerar ao alterar as permissões, consulte "Modificando um registro do GitHub App”.
Em "Inscrever-se em eventos", selecione os eventos de webhook que você deseja que o GitHub App receba.
Clique em Salvar alterações.

Você também pode usar a API REST para criar um webhook para um GitHub App. Para obter mais informações, confira "Pontos de extremidade da API REST de webhooks do GitHub App".