Nota: Este artículo se aplica solo a las aplicaciones de publicación en GitHub Marketplace. Para más información sobre la publicación de GitHub Actions en GitHub Marketplace, consulta "Publicar acciones en GitHub Marketplace".
El webhook de evento de GitHub Marketplace solo puede configurarse desde la página de listado de GitHub Marketplace de tu aplicación. Puede configurar todos los demás eventos desde la página de configuración para desarrolladores de la aplicación. Si no has creado una lista de GitHub Marketplace, lee "Hacer un borrador de un listado para tu app" para saber cómo hacerlo.
Creación de un webhook
Para crear un webhook para la oferta de GitHub Marketplace, haga clic en Webhook en la barra lateral izquierda de la página de la oferta de GitHub Marketplace. Verás las siguientes opciones que se necesitan para configurar tu webhook:
Dirección URL de carga
La dirección URL de la carga es la dirección URL del servidor que va a recibir las solicitudes POST
del webhook.
Tipo de contenido
Los webhooks pueden entregarse utilizando diferentes tipos de contenido:
- El tipo de contenido
application/json
entregará la carga JSON directamente como el cuerpo de la solicitudPOST
. - El tipo de contenido
application/x-www-form-urlencoded
enviará la carga JSON como un parámetro de formulario denominadopayload
.
Elija el que mejor se ajuste a sus necesidades. GitHub recomienda usar el tipo de contenido application/json
.
Secreto
Configurar un secreto de webhook permite garantizar que las solicitudes POST
que se enviaron a la URL de la carga útil sean de GitHub Enterprise Cloud. Cuando establezca un secreto, recibirá los encabezados X-Hub-Signature
y X-Hub-Signature-256
en la solicitud POST
del webhook. Para más información de cómo usar un secreto con un encabezado de firma para proteger las cargas de webhook, consulta "Validación de entregas de webhook".
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 haya configurado el webhook de GitHub Marketplace, podrá inspeccionar las cargas de solicitud de POST
desde la página Webhook de la oferta en GitHub Marketplace de la 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.