Repository Ruleset
This event occurs when there is activity relating to repository rulesets. For more information about repository rulesets, see "Managing rulesets." For more information on managing rulesets via the APIs, see Repository ruleset in the GraphQL documentation or "Repository rules" and "Organization rules in the REST API documentation."
Actions
| Action | Sent when |
|---|---|
created | A repository ruleset was created. |
deleted | A repository ruleset was deleted. |
edited | A repository ruleset was edited. |
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 | No | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
repository_ruleset | object | Yes | A set of rules to apply when specified conditions are met. |
sender | object | Yes | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository or organization permission.