Skip to main content

Tipos de webhooks

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

Sobre os tipos de webhook

Um webhook só pode acessar eventos que estão disponíveis no repositório, organização, conta GitHub Marketplace, conta GitHub Sponsors, ou GitHub App em que está instalado.

Não é possível criar webhooks para contas de usuário individuais ou para eventos específicos dos recursos do usuário, como menções ou notificações pessoais.

Para criar e gerenciar webhooks, você deve ser proprietário ou ter acesso de administrador ao recurso em que o webhook é criado e está ouvindo eventos. Por exemplo, para gerenciar webhooks em uma organização, você precisa de permissões de administrador para essa organização.

Alguns eventos de webhook são exclusivos para certos tipos de webhooks. Por exemplo, um webhook de organização pode assinar eventos que ocorrem apenas no nível da organização, que um webhook de repositório não pode assinar. Para obter mais informações sobre a disponibilidade específica de cada webhook, consulte "Eventos e cargas de webhook."

Para obter mais informações, confira "Sobre webhooks".

Webhooks do repositório

Você pode criar webhooks em um repositório para assinar eventos que ocorrem nesse repositório. Você deve ser proprietário do repositório ou ter acesso de administrador no repositório para criar e gerenciar webhooks em um repositório. Não é possível criar, editar ou excluir webhooks em um repositório em que você não tem as permissões necessárias.

Você pode criar vários webhooks em um único repositório. No entanto, você só pode criar até 20 webhooks que assinam cada tipo de evento individual. Por exemplo, em um único repositório, você só poderia criar até 20 webhooks diferentes em que cada um assina o evento push.

Você pode usar a interface da Web GitHub ou a API REST para gerenciar webhooks do repositório. Para obter mais informações, confira "Criar webhooks", "Editando webhooks" e "Desabilitar webhooks". Para obter mais informações sobre como usar a API REST para gerenciar webhooks de repositório, consulte "Webhooks do repositório".

Webhooks da organização

Você pode criar webhooks em uma organização para assinar eventos que ocorrem nessa organização. Os webhooks da organização podem assinar eventos que acontecem em todos os repositórios de propriedade da organização. Eles também podem assinar eventos que acontecem no nível da organização e estão fora de qualquer repositório específico, como quando um novo membro é adicionado à organização.

Você deve ser proprietário de uma organização para criar e gerenciar webhooks em uma organização.

Você pode criar vários webhooks em uma única organização. No entanto, você só pode criar até 20 webhooks que assinam cada tipo de evento individual. Por exemplo, em uma única organização, você só poderia criar até 20 webhooks diferentes em que cada um assina o evento push.

Você pode usar a interface da Web GitHub ou a API REST para gerenciar webhooks da organização. Para obter mais informações, confira "Criar webhooks", "Editando webhooks" e "Desabilitar webhooks". Para obter mais informações sobre como usar a API REST para gerenciar webhooks da organização, consulte "Webhooks da organização".

Webhooks do GitHub Marketplace

Você pode criar um webhook para assinar eventos relacionados a um aplicativo publicado em GitHub Marketplace. Você só pode criar um webhook para cada aplicativo no GitHub Marketplace. Somente o proprietário do aplicativo ou um gerente de aplicativo da organização proprietária do aplicativo pode criar e gerenciar um webhook do GitHub Marketplace.

Um webhook do GitHub Marketplace não pode ser excluído, mas você pode desativá-lo para parar de receber entregas de webhook.

Você pode usar a interface da Web do GitHub para gerenciar um webhook do GitHub Marketplace. Para obter mais informações, confira "Criar webhooks", "Editando webhooks" e "Desabilitar webhooks".

Webhooks do GitHub Sponsors

Você pode criar webhooks para assinar eventos relacionados ao GitHub Sponsors. Você só pode criar até 20 webhooks para uma conta GitHub Sponsors.

Você deve ser proprietário de uma conta ou ter acesso de administrador na conta patrocinada para gerenciar webhooks de patrocínio.

Você pode usar a interface da Web do GitHub para gerenciar webhooks do GitHub Sponsors. Para saber mais, confira "Criar webhooks", "Editando webhooks" e "Desabilitar webhooks".

Webhooks do GitHub App

Você pode configurar um GitHub App para receber webhooks quando eventos específicos ocorrerem em um repositório ou organização ao qual o aplicativo recebeu acesso.

Cada GitHub App tem um único webhook que é criado automaticamente pelo GitHub. Por padrão, o webhook não é inscrito em nenhum evento. Você pode configurar os eventos que o webhook assina. Um webhook do GitHub App não pode ser excluído, mas você pode desativá-lo para parar de receber entregas de webhook.

Você pode usar a interface da Web do GitHub ou a API REST para gerenciar um webhook do GitHub App. Para obter mais informações, confira "Criar webhooks", "Editando webhooks" e "Desabilitar webhooks". Para obter mais informações sobre como usar a API REST para gerenciar webhooks do GitHub App, consulte "Webhooks do Aplicativo do GitHub".