Installation

This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.

Actions

ActionSent when
createdSomeone installed a GitHub App on a user or organization account.
deletedSomeone uninstalled a GitHub App from their user or organization account.
new-permissions-acceptedSomeone granted new permissions to a GitHub App.
suspendSomeone blocked access by a GitHub App to their user or organization account.
unsuspendA GitHub App that was blocked from accessing a user or organization account was given access the account again.

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
installationobjectYesInstallation
organizationobjectNoA GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an
repositoriesarray<object>NoAn array of repository objects that the installation can access.
repositoryobjectNoThe repository on GitHub where the event occurred. Webhook payloads contain the repository property
requesterobjectNo
senderobjectYesA GitHub user.