Release
This event occurs when there is activity relating to releases. For more information, see "About releases." For information about the APIs to manage releases, see the GraphQL API documentation or "Releases" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
created | A draft was saved, or a release or pre-release was published without previously being saved as a draft. |
deleted | A release, pre-release, or draft release was deleted. |
edited | The details of a release, pre-release, or draft release were edited. For more information, see "Managing releases in a repository." |
prereleased | A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable. |
published | A release, pre-release, or draft of a release was published. |
released | A release was published, or a pre-release was changed to a release. |
unpublished | A release or pre-release was unpublished. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | Yes | |
enterprise | object | No | An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
release | object | Yes | The release object. |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
sender | object | Yes | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.