Merge Group
This event occurs when there is activity relating to a merge group in a merge queue. For more information, see "Managing a merge queue."
Actions
| Action | Sent when |
|---|---|
checks-requested | Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued. |
destroyed | The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed. |
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 | |
installation | object | No | The GitHub App installation. Webhook payloads contain the installation property when the event is configured |
merge_group | object | Yes | A group of pull requests that the merge queue has grouped together to be merged. |
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 |
sender | object | No | A GitHub user. |
Subscribing
To subscribe to this event, a GitHub App must have at least read-level access for the "Merge queues" repository permission.