Sponsorship

This event occurs when there is activity relating to a sponsorship listing. For more information, see "About GitHub Sponsors." For information about the API to manage sponsors, see the GraphQL documentation.

Actions

ActionSent when
cancelledA sponsorship was cancelled and the last billing cycle has ended.
createdA sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.
editedA monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.
pending-cancellationA sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.
pending-tier-changeA sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.
tier-changedA sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.

Payload

Fields of the delivery for the first action above. Every action shares the event's core fields.

FieldTypeRequiredDescription
actionstringYes
enterpriseobjectNoAn enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured
installationobjectNoThe GitHub App installation. Webhook payloads contain the installation property when the event is configured
organizationobjectNoA GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an
repositoryobjectNoThe repository on GitHub where the event occurred. Webhook payloads contain the repository property
senderobjectYesA GitHub user.
sponsorshipobjectYes