Eventos de webhook para la API de GitHub Marketplace

Acerca de webhooks y GitHub Marketplace

Las solicitudes POST de webhooks tienen encabezados especiales. Consulta "Eventos y cargas de webhook" para obtener más detalles. 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. Para más información sobre cómo crear y deshabilitar webhooks GitHub Marketplace, consulte “Crear webhooks” y “Desactivación de webhooks”.

Las cancelaciones y disminuciones de categoría toman efecto el primer día del siguiente ciclo de facturación. Los eventos para las cancelaciones y disminuciones de categoría se envían cuando el nuevo plan entre en vigor al inicio del siguiente ciclo de facturación. Los eventos para las nuevas compras y mejoras de categoría comienzan inmediatamente. Use effective_date en la carga de webhook para determinar cuándo se iniciará un cambio.

Acerca de la carga de webhook de compra para GitHub Marketplace

Cada carga de webhook marketplace_purchase tendrá la siguiente información:

Clave	Tipo	Descripción
action	string	La acción realizada para generar el webhook. Puede ser purchased, cancelled, pending_change, pending_change_cancelled o changed. Para obtener más información, consulta los ejemplos de cargas útiles de webhook a continuación. Nota: Las cargas pending_change y pending_change_cancelled contienen las mismas claves que se muestran en el ejemplo de carga changed.
effective_date	string	Fecha en la que action entra en vigor.
sender	object	Persona que ha tomado el elemento action que ha desencadenado el webhook.
marketplace_purchase	object	La información de compra de GitHub Marketplace.

El objeto marketplace_purchase tiene las claves siguientes:

Clave	Tipo	Descripción
account	object	La cuenta de organization o user asociada a la suscripción. Las cuentas de organización incluirán organization_billing_email, que es la dirección de correo electrónico administrativa de la organización. A fin de buscar direcciones de correo electrónico para cuentas personales, puede usar el punto de conexión Obtener el usuario autenticado.
billing_cycle	string	Puede ser yearly o monthly. Cuando el propietario de account tiene un plan gratuito de GitHub y ha comprado un plan de GitHub Marketplace gratuito, billing_cycle será nil.
unit_count	integer	Cantidad de unidades compradas.
on_free_trial	boolean	true cuando account está en una evaluación gratuita.
free_trial_ends_on	string	La fecha en la que caduca el periodo de prueba gratuito.
next_billing_date	string	La fecha en la que comenzará el siguiente ciclo de facturación. Cuando el propietario de account tiene un plan gratuito de GitHub.com y ha comprado un plan de GitHub Marketplace gratuito, next_billing_date será nil.
plan	object	Plan comprado por user o organization.

El objeto plan tiene las claves siguientes:

Clave	Tipo	Descripción
id	integer	El identificador único para este plan.
name	string	El nombre del plan.
description	string	La descripción de este plan.
monthly_price_in_cents	integer	El precio mensual de este plan en centavos (Divisa de los EEUU). Por ejemplo, un listado que cuesta 10 dólares de EEUU por mes sería de 1000 centavos.
yearly_price_in_cents	integer	El precio anual para este plan en centavos (Divisa de los EEUU). Por ejemplo, un listado que cuesta 100 USD al mes sería 120 000 centavos.
price_model	string	El modelo de precios para este listado. Puede ser FLAT_RATE, PER_UNIT o FREE.
has_free_trial	boolean	true cuando esta oferta ofrece una evaluación gratuita.
unit_name	string	El nombre de la unidad. Si el modelo de precios no es per-unit, será nil.
bullet	array of strings	Los nombres de los puntos configurados en el plan de precios.