Pull Request
This event occurs when there is activity on a pull request. For more information, see "About pull requests." For information about the APIs to manage pull requests, see the GraphQL API documentation or "Pulls" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
assigned | A pull request was assigned to a user. |
auto-merge-disabled | Auto merge was disabled for a pull request. For more information, see "Automatically merging a pull request." |
auto-merge-enabled | Auto merge was enabled for a pull request. For more information, see "Automatically merging a pull request." |
closed | A pull request was closed. If merged is false in the webhook payload, the pull request was closed with unmerged commits. If merged is true in the webhook payload, the pull request was merged. |
converted-to-draft | A pull request was converted to a draft. For more information, see "Changing the stage of a pull request." |
demilestoned | A pull request was removed from a milestone. |
dequeued | A pull request was removed from the merge queue. |
edited | The title or body of a pull request was edited, or the base branch of a pull request was changed. |
enqueued | A pull request was added to the merge queue. |
labeled | A label was added to a pull request. |
locked | Conversation on a pull request was locked. For more information, see "Locking conversations." |
milestoned | A pull request was added to a milestone. |
opened | A pull request was created |
ready-for-review | A draft pull request was marked as ready for review. For more information, see "Changing the stage of a pull request." |
reopened | A previously closed pull request was reopened. |
review-request-removed | A request for review by a person or team was removed from a pull request. |
review-requested | Review by a person or team was requested for a pull request. For more information, see "Requesting a pull request review." |
stacked | A pull request was added to a stack. |
synchronize | A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch. |
unassigned | A user was unassigned from a pull request. |
unlabeled | A label was removed from a pull request. |
unlocked | Conversation on a pull request was unlocked. For more information, see "Locking conversations." |
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 | |
assignee | object | 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 |
number | integer | Yes | The pull request number. |
organization | object | No | A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an |
pull_request | object | Yes | |
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 "Pull requests" repository permission.