Configurar um webhook para notificá-lo de alterações de plano

Depois de criar uma listagem de rascunho de GitHub Marketplace, você pode configurar um webhook que notifique quando ocorrerem alterações nos planos da conta do cliente. Depois de configurar o webhook, você pode lidar com os tipos de eventos do marketplace_purchase em seu aplicativo.

Neste artigo

Observação

Este artigo se aplica somente a aplicativos publicados em GitHub Marketplace. Para obter mais informações sobre como publicar GitHub Actions em GitHub Marketplace, consulte Publicar ações no GitHub Marketplace.

O evento do webhook do GitHub Marketplace só pode ser configurado a partir da página de listagem GitHub Marketplace do seu aplicativo. Você pode configurar todos os outros eventos na página de configurações do desenvolvedor do aplicativo. Se você ainda não criou uma listagem de GitHub Marketplace, leia Elaborar uma listagem para o seu aplicativo para saber como.

Criando um webhook

Para criar um webhook para sua listagem do GitHub Marketplace, clique em Webhook na barra lateral esquerda da página de listagem do GitHub Marketplace. Você verá as seguintes opções de configuração de webhook necessárias para configurar seu webhook:

URL do conteúdo

A URL do conteúdo é a URL do servidor que receberá as solicitações POST do webhook.

Tipo de conteúdo

Os webhooks podem ser entregues usando diferentes tipos de conteúdo:

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

Selecione a mais adequada às suas necessidades. O GitHub recomenda usar o tipo de conteúdo application/json.

Segredo

Definir um segredo de webhook permite garantir que as solicitações enviadas por POST para a URL do payload vieram de GitHub. Quando você definir um segredo, você receberá os cabeçalhos X-Hub-Signature e X-Hub-Signature-256 na requisiçã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 Validação de entregas de webhooks.

Ativo

Por padrão, as entregas de webhook estão "Ativas". Você pode escolher desativar a entrega das cargas do webhook durante o desenvolvimento, desmarcando a opção "Ativo". Se você desativou as entregas do webhook, será necessário selecionar "Ativo" antes de enviar seu aplicativo para revisão.

Visualizar entregas do webhook

Depois de configurar o webhook do GitHub Marketplace, você poderá inspecionar o conteúdo da solicitação POST na página Webhook da listagem do GitHub Marketplace do aplicativo. GitHub não reenvia as tentativas de entrega com falha. Verifique se seu aplicativo pode receber todos os conteúdos de webhook enviados por GitHub.

Captura de tela das entregas recentes do webhook para listagem do GitHub Marketplace.