Configurar un webhook para que te notifique sobre los cambios de plan

Después de [crear un listado de GitHub Marketplace en borrador] (/marketplace/listing-on-github-marketplace/creating-a-draft-github-marketplace-listing/), puedes configurar un webhook que te notifique cuando sucedan cambios en los planes de la cuenta de los clientes. Después de que configures el webhook, puedes [gestionar los tipos de evento de marketplace_purchase] (/marketplace/integrating-with-the-github-marketplace-api/github-marketplace-webhook-events/) en tu app.

El webhook de evento de GitHub Marketplace solo puede configurarse desde la página de listado de GitHub Marketplace de tu aplicación. Puedes configurar el resto de los eventos desde la página de configuración del desarrollador de la aplicación. Si no has creado un listado de GitHub Marketplace, lee la sección "Crear un borrador de listado de GitHub Marketplace" para aprender cómo hacerlo.

Crear un webhook

Para crear un webhook para tu listado de GitHub Marketplace, da clic en Webhooks en la barra lateral de tu página de listado de GitHub Marketplace. Verás las siguientes opciones que se necesitan para configurar tu webhook:

URL de la carga útil

La URL de carga útil es la URL del servidor que recibirá las solicitudes de POST del webhook.

Tipo de contenido

Los webhooks pueden entregarse utilizando diferentes tipos de contenido:

  • El tipo de contenido application/json entregará la carga útil de JSON directametne como el cuerpo de la solicitud POST.
  • El tipo de contenido application/x-www-form-urlencoded enviará la carga útil de JSON como un parámetro de forma llamado payload.

Elige el que se adapte mejor a tus necesidades. GitHub te recomienda utilizar el tipo de contenido application/json.

Secreto

El configurar un secreto de webhook te permite garantizar que las solicitudes POST que se enviaron a la URL de la carga útil sean de GitHub. Cuando configuras un secreto, recibirás los encabezados de X-Hub-Signature y de X-Hub-Signature-256 en la solicitud de POST del webhook. Para obtener más información sobre cómo utilizar uns ecreto con un encabezado de firma para asegurar tus cárgas útiles de webhook, consulta la sección "Asegurar tus webhooks".

Activo

Predeterminadamente, las entregas de webhook están "Activas". También puedes elegir inhabilitar la entrega de cargas útiles de webhooks durante el desarrollo si deseleccionas "Activo". Si inhabilitaste las entregas de los webhooks, necesitarás seleccionar "Activo" antes de que emitas tu app para su revisión.

Visualizar las entregas de los webhooks

Una vez que hayas configurado tu webhook de GitHub Marketplace, podrás inspecionar las cargas útiles de las solicitudes de tipo POST desde la página del Webhooks del listado de GitHub Marketplace de tu aplicación. GitHub no reenvía los intentos fallidos de entrega. Asegúrate de que tu app pueda recibir toda la carga útil del webhook que envíe GitHub.

Inspeccionar las entregas de webhooks de GitHub Marketplace recientes

¿Te ayudó este documento?

Política de privacidad

¡Ayúdanos a hacer geniales estos documentos!

Todos los documentos de GitHub son de código abierto. ¿Notas algo que esté mal o que no sea claro? Emite una solicitud de cambios.

Haz una contribución

O, aprende cómo contribuir.