You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/v3/activity/events/types.md
+23-15Lines changed: 23 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -239,15 +239,19 @@ Key | Type | Description
239
239
240
240
## IssueCommentEvent
241
241
242
+
{% if page.version == 'dotcom' or page.version > 2.6 %}
242
243
Triggered when an [issue comment](/v3/issues/comments/) is created, edited, or deleted.
244
+
{% else %}
245
+
Triggered when an [issue is commented on](/v3/issues/comments/).
246
+
{% endif %}
243
247
244
248
### Events API payload
245
249
246
250
Key | Type | Description
247
251
----|------|-------------
248
-
`action`|`string` | The action that was performed on the comment. Can be one of "created", "edited", or "deleted".
252
+
`action`|`string` | The action that was performed on the comment. {% if page.version == 'dotcom' or page.version > 2.6 %}Can be one of "created", "edited", or "deleted".
249
253
`changes`|`object` | The changes to the comment if the action was "edited".
250
-
`changes[body][from]` |`string` | The previous version of the body if the action was "edited".
254
+
`changes[body][from]` |`string` | The previous version of the body if the action was "edited".{% else %}Currently, can only be "created".{% endif %}
251
255
`issue`|`object` | The [issue](/v3/issues/) the comment belongs to.
252
256
`comment`|`object` | The [comment](/v3/issues/comments/) itself.
253
257
@@ -261,17 +265,17 @@ Key | Type | Description
261
265
262
266
## IssuesEvent
263
267
264
-
Triggered when an [issue](/v3/issues) is assigned, unassigned, labeled, unlabeled, opened, edited, closed, or reopened.
268
+
Triggered when an [issue](/v3/issues) is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, or reopened.
265
269
266
270
### Events API payload
267
271
268
272
Key | Type | Description
269
273
----|------|-------------
270
-
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "edited", "closed", or "reopened".
271
-
`issue`|`object` | The [issue](/v3/issues) itself.
274
+
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", {% if page.version == 'dotcom' or page.version > 2.6 %}"edited", {% endif %}"closed", or "reopened".
275
+
`issue`|`object` | The [issue](/v3/issues) itself.{% if page.version == 'dotcom' or page.version > 2.6 %}
272
276
`changes`|`object`| The changes to the issue if the action was "edited".
273
277
`changes[title][from]`|`string` | The previous version of the title if the action was "edited".
274
-
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".
278
+
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% endif %}
275
279
`assignee`|`object` | The optional user who was assigned or unassigned from the issue.
276
280
`label`|`object` | The optional label that was added or removed from the issue.
277
281
@@ -363,17 +367,17 @@ Triggered when a private repository is [open sourced](/v3/repos/#edit). Without
363
367
364
368
## PullRequestEvent
365
369
366
-
Triggered when a [pull request](/v3/pulls) is assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, or synchronized.
370
+
Triggered when a [pull request](/v3/pulls) is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, reopened, or synchronized.
367
371
368
372
### Events API payload
369
373
370
374
Key | Type | Description
371
375
----|------|-------------
372
-
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", "edited", "closed", or "reopened", or "synchronize". If the action is "closed" and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is "closed" and the `merged` key is `true`, the pull request was merged.
373
-
`number`|`integer` | The pull request number.
376
+
`action`|`string` | The action that was performed. Can be one of "assigned", "unassigned", "labeled", "unlabeled", "opened", {% if page.version == 'dotcom' or page.version > 2.6 %}"edited", {% endif %}"closed", or "reopened", or "synchronize". If the action is "closed" and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is "closed" and the `merged` key is `true`, the pull request was merged.
377
+
`number`|`integer` | The pull request number.{% if page.version == 'dotcom' or page.version > 2.6 %}
374
378
`changes`|`object`| The changes to the comment if the action was "edited".
375
379
`changes[title][from]`|`string` | The previous version of the title if the action was "edited".
376
-
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".
380
+
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% endif %}
377
381
`pull_request`|`object` | The [pull request](/v3/pulls) itself.
378
382
379
383
### Webhook event name
@@ -386,15 +390,19 @@ Key | Type | Description
386
390
387
391
## PullRequestReviewCommentEvent
388
392
393
+
{% if page.version == 'dotcom' or page.version > 2.6 %}
389
394
Triggered when a [comment on a Pull Request's unified diff](/v3/pulls/comments) is created, edited, or deleted (in the Files Changed tab).
395
+
{% else %}
396
+
Triggered when a [Pull Request's unified diff is commented on](/v3/pulls/comments) (in the Files Changed tab).
397
+
{% endif %}
390
398
391
399
### Events API payload
392
400
393
401
Key | Type | Description
394
402
----|------|-------------
395
-
`action`|`string` | The action that was performed on the comment. Can be one of `created`, `edited`, or `deleted`.
403
+
`action`|`string` | The action that was performed on the comment. {% if page.version == 'dotcom' or page.version > 2.6 %}Can be one of "created", "edited", or "deleted".
396
404
`changes`|`object`| The changes to the comment if the action was "edited".
397
-
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".
405
+
`changes[body][from]`|`string` | The previous version of the body if the action was "edited".{% else %}Currently, can only be "created".{% endif %}
398
406
`pull_request`|`object` | The [pull request](/v3/pulls/) the comment belongs to.
399
407
`comment`|`object` | The [comment](/v3/pulls/comments) itself.
400
408
@@ -463,15 +471,15 @@ Key | Type | Description
463
471
464
472
## RepositoryEvent
465
473
466
-
Triggered when a repository is created, deleted, made public, or made private.
474
+
Triggered when a repository is created{% if page.version == 'dotcom' or page.version > 2.6 %}, deleted, made public, or made private{% endif %}.
467
475
468
-
Events of this type are not visible in timelines. These events are only used to trigger hooks.
476
+
Events of this type are not visible in timelines. These events are only used to trigger {% if page.version != 'dotcom' and page.version <= 2.6 %}organization {% endif %}hooks.
469
477
470
478
### Events API payload
471
479
472
480
Key | Type | Description
473
481
----|------|-------------
474
-
`action` |`string` | The action that was performed. This can be one of `created`, `deleted`, `publicized`, or `privatized`.
482
+
`action` |`string` | The action that was performed. {% if page.version == 'dotcom' or page.version > 2.6 %}This can be one of "created", "deleted", "publicized", or "privatized".{% else %}Currently, can only be "created".{% endif %}
475
483
`repository`|`object` | The [repository](/v3/repos/) itself.
Copy file name to clipboardExpand all lines: content/webhooks/index.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,16 +48,16 @@ Name | Description
48
48
[`deployment_status`][event-types-deployment_status] | Any time a deployment for a Repository has a status update from the API.
49
49
[`fork`][event-types-fork] | Any time a Repository is forked.
50
50
[`gollum`][event-types-gollum] | Any time a Wiki page is updated.
51
-
[`issue_comment`][event-types-issue_comment] | Any time a [comment on an issue](/v3/issues/comments/) is created, edited, or deleted.
52
-
[`issues`][event-types-issues] | Any time an Issue is assigned, unassigned, labeled, unlabeled, opened, edited, closed, or reopened.
51
+
[`issue_comment`][event-types-issue_comment] | {% if page.version == 'dotcom' or page.version > 2.6 %}Any time a [comment on an issue](/v3/issues/comments/) is created, edited, or deleted.{% else %}Any time an [issue is commented on](/v3/issues/comments).{% endif %}
52
+
[`issues`][event-types-issues] | Any time an Issue is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, or reopened.
53
53
[`member`][event-types-member] | Any time a User is added as a collaborator to a non-Organization Repository.
54
54
[`membership`][event-types-membership] | Any time a User is added or removed from a team. **Organization hooks only**.
55
55
[`page_build`][event-types-page_build] | Any time a Pages site is built or results in a failed build.
56
56
[`public`][event-types-public] | Any time a Repository changes from private to public.
57
-
[`pull_request_review_comment`][event-types-pull_request_review_comment] | Any time a [comment on a pull request's unified diff](/v3/pulls/comments) is created, edited, or deleted (in the Files Changed tab).
58
-
[`pull_request`][event-types-pull_request] | Any time a Pull Request is assigned, unassigned, labeled, unlabeled, opened, edited, closed, reopened, or synchronized (updated due to a new push in the branch that the pull request is tracking).
57
+
[`pull_request_review_comment`][event-types-pull_request_review_comment] | {% if page.version == 'dotcom' or page.version > 2.6 %}Any time a [comment on a Pull Request's unified diff](/v3/pulls/comments) is created, edited, or deleted{% else %}Any time a [Pull Request's unified diff is commented on](/v3/pulls/comments){% endif %} (in the Files Changed tab).
58
+
[`pull_request`][event-types-pull_request] | Any time a Pull Request is assigned, unassigned, labeled, unlabeled, opened, {% if page.version == 'dotcom' or page.version > 2.6 %}edited, {% endif %}closed, reopened, or synchronized (updated due to a new push in the branch that the pull request is tracking).
59
59
[`push`][event-types-push] | Any Git push to a Repository, including editing tags or branches. Commits via API actions that update references are also counted. **This is the default event.**
60
-
[`repository`][event-types-repository] | Any time a Repository is created, deleted, made public, or made private.
60
+
[`repository`][event-types-repository] | Any time a Repository is created{% if page.version == 'dotcom' or page.version > 2.6 %}, deleted, made public, or made private{% else %}. **Organization hooks only**{% endif %}.
61
61
[`release`][event-types-release] | Any time a Release is published in a Repository.
62
62
[`status`][event-types-status] | Any time a Repository has a status update from the API
63
63
[`team_add`][event-types-team_add] | Any time a team is added or modified on a Repository.
0 commit comments