Skip to content

Commit 6189de4

Browse files
author
Sarah Edwards
authored
add pr thread event (github#26909)
1 parent 345a950 commit 6189de4

File tree

6 files changed

+581
-0
lines changed

6 files changed

+581
-0
lines changed

content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,6 +122,7 @@ Webhook event name | Required permission | Description
122122
[`pull_request`](/webhooks/event-payloads/#pull_request) | `pull_requests` | {% data reusables.webhooks.pull_request_short_desc %}
123123
[`pull_request_review`](/webhooks/event-payloads/#pull_request_review) | `pull_request` | {% data reusables.webhooks.pull_request_review_short_desc %}
124124
[`pull_request_review_comment`](/webhooks/event-payloads/#pull_request_review_comment) | `pull_request` | {% data reusables.webhooks.pull_request_review_comment_short_desc %}
125+
[`pull_request_review_thread`](/webhooks/event-payloads/#pull_request_review_thread) | `pull_request` | {% data reusables.webhooks.pull_request_review_thread_short_desc %}
125126
[`push`](/webhooks/event-payloads/#push) | `contents` | {% data reusables.webhooks.push_short_desc %}
126127
[`release`](/webhooks/event-payloads/#release) | `contents` | {% data reusables.webhooks.release_short_desc %}
127128
[`repository`](/webhooks/event-payloads/#repository) |`metadata` | {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %}

content/developers/webhooks-and-events/events/github-event-types.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,16 @@ Key | Type | Description
207207
{% data reusables.webhooks.pull_request_review_comment_event_api_properties %}
208208
{% data reusables.webhooks.pull_request_review_comment_properties %}
209209

210+
## PullRequestReviewThreadEvent
211+
212+
{% data reusables.webhooks.pull_request_review_thread_short_desc %}
213+
214+
{% data reusables.webhooks.events_api_payload %}
215+
216+
### Event `payload` object
217+
218+
{% data reusables.webhooks.pull_request_thread_properties %}
219+
210220
## PushEvent
211221

212222
{% data reusables.webhooks.push_short_desc %}

content/developers/webhooks-and-events/webhooks/webhook-events-and-payloads.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1060,6 +1060,28 @@ Deliveries for `review_requested` and `review_request_removed` events will have
10601060
10611061
{{ webhookPayloadsForCurrentVersion.pull_request_review_comment.created }}
10621062
1063+
## pull_request_review_thread
1064+
1065+
{% data reusables.webhooks.pull_request_review_thread_short_desc %}
1066+
1067+
### Availability
1068+
1069+
- Repository webhooks
1070+
- Organization webhooks
1071+
- {% data variables.product.prodname_github_apps %} with the `pull_requests` permission
1072+
1073+
### Webhook payload object
1074+
1075+
{% data reusables.webhooks.pull_request_thread_properties %}
1076+
{% data reusables.webhooks.repo_desc %}
1077+
{% data reusables.webhooks.org_desc %}
1078+
{% data reusables.webhooks.app_desc %}
1079+
{% data reusables.webhooks.sender_desc %}
1080+
1081+
### Webhook payload example
1082+
1083+
{{ webhookPayloadsForCurrentVersion.pull_request_review_thread.resolved }}
1084+
10631085
## push
10641086
10651087
{% data reusables.webhooks.push_short_desc %}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Activity related to a comment thread on a pull request being marked as resolved or unresolved. {% data reusables.webhooks.action_type_desc %}
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
Key | Type | Description
2+
----|------|------------
3+
`action` | `string` | The action that was performed. Can be one of:<ul><li>`resolved` - A comment thread on a pull request was marked as resolved.</li><li>`unresolved` - A previously resolved comment thread on a pull request was marked as unresolved.</li></ul>
4+
`pull_request` | `object` | The [pull request](/rest/reference/pulls) the thread pertains to.
5+
`thread` | `object` | The thread that was affected.

0 commit comments

Comments
 (0)