Deployment Protection Rule
This event occurs when there is activity relating to deployment protection rules. For more information, see "Using environments for deployment." For information about the API to manage deployment protection rules, see the REST API documentation.
Actions
| Action | Sent when |
|---|---|
requested | A deployment protection rule was requested for an environment. |
Payload
Fields of the delivery for the first action above. Every action shares the event's core fields.
| Field | Type | Required | Description |
|---|---|---|---|
action | string | No | |
environment | string | No | The name of the environment that has the deployment protection rule. |
event | string | No | The event that triggered the deployment protection rule. |
sha | string | No | The commit SHA that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. |
ref | string | No | The ref (branch or tag) that triggered the workflow. Always populated from the check suite, regardless of whether a deployment is created. |
deployment_callback_url | string | No | The URL to review the deployment protection rule. |
deployment | object | No | A request for a specific ref(branch,sha,tag) to be deployed |
pull_requests | array<object> | No | |
repository | object | No | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
sender | object | No | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.