Undocumented event "PullRequestReviewEvent"

[lowlighter]

What article on docs.github.com is affected?

• https://docs.github.com/en/free-pro-team@latest/developers/webhooks-and-events/github-event-types

What part(s) of the article would you like to see updated?

Seems that while both PullRequestEvent and PullRequestReviewCommentEvent are referenced, but PullRequestReviewEvent is not.

Additional information

Below is an extract of what the event looks like.

  {
    id: '14732962106',
    type: 'PullRequestReviewEvent',
    actor: {...},
    repo: {...},
    payload: {
      action: 'created',
      review: {
        user: {...},
        body: '',
        state: 'approved',
      },
      pull_request: {
        user: {...},
        body: '',
        head: {...},
        base: {...},
        _links: {...},
      }
    },
    public: true,
    created_at: '2021-01-06T16:45:16Z'
  }

[welcome]

Thanks for opening this issue. A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

[kiepngheonha]

Cảm ơn bạn đã mở vấn đề này. Một thành viên trong nhóm tài liệu GitHub nên sớm đưa ra phản hồi. Trong thời gian chờ đợi, vui lòng xem các nguyên tắc đóng góp .

#2722 (comment)

[chiedo]

@lowlighter Thanks for opening an issue! I’ll triage this for the right team to take a look 👀

[runleonarun]

Thanks for opening this issue, @lowlighter!

Looks like the issue is we need to add the reusables found here:
https://github.com/github/docs/blob/main/data/reusables/webhooks/pull_request_review_properties.md
https://github.com/github/docs/blob/main/data/reusables/webhooks/pull_request_review_short_desc.md
https://github.com/github/docs/blob/main/data/reusables/webhooks/events_api_payload.md

To this page:
https://github.com/github/docs/blob/main/content/developers/webhooks-and-events/github-event-types.md

We also need to create a reusable for pull_request_review_event_api_properties.md and add it to the above file. I'd need to test this to see what it should include.

[runleonarun]

To @lowlighter or anyone who wants to fix this, I just wanted to add some more details:

To fix this issue and add PullRequestReviewEvent to the GitHub Event Types page, you would add a new section with headings and content from reusable files.

For example, you would add the following to the github-event-type.md file after PullRequestEvent and beforePullRequestReviewCommentEvent

 ### PullRequestReviewEvent

{% data reusables.webhooks.pull_request_review_short_desc %}
{% data reusables.webhooks.events_api_payload %}

#### Event `payload` object

{% data reusables.webhooks.pull_request_review_properties %}

[lowlighter]

So something like main...lowlighter:main ?

I assume that there are more actions than just created but seems you're already experimenting on it.
If not I can test from my side and add the one I found 🙂