Repository
This event occurs when there is activity relating to repositories. For more information, see "About repositories." For information about the APIs to manage repositories, see the GraphQL documentation or "Repositories" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
archived | A repository was archived. |
created | A repository was created. |
deleted | A repository was deleted. GitHub Apps and repository webhooks will not receive this event. |
edited | The topics, default branch, description, or homepage of a repository was changed. |
privatized | The visibility of a repository was changed to private. |
publicized | The visibility of a repository was changed to public. |
renamed | The name of a repository was changed. |
transferred | Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the repository.transferred event, the new owner account must have the GitHub App installed, and the App must be subscribed to "Repository" events. |
unarchived | A previously archived repository was unarchived. |
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 |
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 "Metadata" repository permission.