Pull Request Review
This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "About pull request reviews." For information about the APIs to manage pull request reviews, see the GraphQL API documentation or "Pull request reviews" in the REST API documentation.
Actions
| Action | Sent when |
|---|---|
dismissed | A review on a pull request was dismissed. |
edited | The body comment on a pull request review was edited. |
submitted | A review on a pull request was submitted. |
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 |
pull_request | object | Yes | |
repository | object | Yes | The repository on GitHub where the event occurred. Webhook payloads contain the repository property |
review | object | Yes | The review that was affected. |
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.