Publicamos atualizações frequentes em nossa documentação, e a tradução desta página ainda pode estar em andamento. Para obter as informações mais recentes, acesse a documentação em inglês. Se houver problemas com a tradução desta página, entre em contato conosco.

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

Após criar um rascunho da listagem do GitHub Marketplace , você pode configurar um webhook que notifica você quando ocorrem alterações nos planos da conta do cliente. Após configurar o webhook, você pode gerenciar os tipos de evento marketplace_purchase no seu aplicativo.

Neste artigo

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 a partir da página de configurações de desenvolvedor do seu aplicativo. Se você não criou uma listagem do GitHub Marketplace, leia "Criando um rascunho da listagem GitHub Marketplace" para aprender como fazê-lo.

Criar um webhook

Para criar um webhook para sua listagem do GitHub Marketplace, clique em Webhook na barra lateral esquerda da sua 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 de carga

A URL doa carga é a URL do servidor que receberá as solicitações de POST do webhook.

Tipo de conteúdo

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

  • O tipo de conteúdo de application/json fornecerá a carga do JSON diretamente como o texto da solicitação POST.
  • O tipo de conteúdo application/x-www-form-urlencoded enviará a carga do JSON como um parâmetro de formulário denominado carga.

Escolha o que melhor se adeque às suas necessidades. O GitHub recomenda usar o tipo de conteúdo application/json.

Segredo

Definir um segredo de webhook permite que você certifique-se de que as solicitações POST enviadas para a URL da carga são de GitHub. When you set a secret, you'll receive the X-Hub-Signature and X-Hub-Signature-256 headers in the webhook POST request. Para obter mais informações sobre como usar um segredo com um cabeçalho de assinatura para proteger as suas cargas do webhook, veja "Proteger seus webhooks."

Ativo

Por padrão, as entregas de webhook estão "Ativas". Você pode optar por desativar a entrega das cargas de webhook durante o desenvolvimento, desmarcando "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

Uma vez configurado seu webhook do GitHub Marketplace , você poderá inspecionar as cargas de solicitação de POST da página do Webhook da lista do seu aplicativo do GitHub Marketplace. O GitHub não reenvia tentativas falhas de entrega. Certifique-se de que seu aplicativo possa receber todas as cargas do webhook enviadas pelo GitHub.

Inspecione as entregas recentes do webhook de GitHub Marketplace

Esse documento ajudou você?

Privacy policy

Ajude-nos a tornar esses documentos ótimos!

Todos os documentos do GitHub são de código aberto. Você percebeu que algo que está errado ou não está claro? Envie um pull request.

Faça uma contribuição

Ou, aprenda como contribuir.