-
Notifications
You must be signed in to change notification settings - Fork 41
/
index.json
1767 lines (1767 loc) · 85.1 KB
/
index.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
[
{
"name": "branch_protection_rule",
"description": "Activity related to a branch protection rule. For more information, see \"[About branch protection rules](https://docs.github.com/en/enterprise-server@3.3/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-rules).\"",
"properties": {
"rule": {
"type": "object",
"description": "The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/en/enterprise-server@3.3/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings."
},
"changes": {
"type": "object",
"description": "If the action was `edited`, the changes to the rule."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created", "deleted", "edited"],
"examples": []
},
{
"name": "check_run",
"description": "Check run activity has occurred. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[check runs](https://docs.github.com/en/enterprise-server@3.3/rest/reference/checks#runs)\" REST API.",
"properties": {
"check_run": {
"type": "object",
"description": "The [check\\_run](https://docs.github.com/en/enterprise-server@3.3/rest/reference/checks#get-a-check-run)."
},
"check_run[status]": {
"type": "string",
"description": "The current status of the check run. Can be `queued`, `in_progress`, or `completed`."
},
"check_run[conclusion]": {
"type": "string",
"description": "The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`."
},
"check_run[name]": {
"type": "string",
"description": "The name of the check run."
},
"check_run[check_suite][id]": {
"type": "integer",
"description": "The id of the check suite that this check run is part of."
},
"check_run[check_suite][pull_requests]": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
},
"check_run[check_suite][deployment]": {
"type": "object",
"description": "A deployment to a repository environment. This will only be populated if the check run was created by a GitHub Actions workflow job that references an environment."
},
"requested_action": {
"type": "object",
"description": "The action requested by the user."
},
"requested_action[identifier]": {
"type": "string",
"description": "The integrator reference of the action requested by the user."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["completed", "created", "requested_action", "rerequested"],
"examples": []
},
{
"name": "check_suite",
"description": "Check suite activity has occurred. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[check suites](https://docs.github.com/en/enterprise-server@3.3/rest/reference/checks#suites)\" REST API.",
"properties": {
"check_suite": {
"type": "object",
"description": "The [check\\_suite](https://docs.github.com/en/enterprise-server@3.3/rest/reference/checks#suites)."
},
"check_suite[head_branch]": {
"type": "string",
"description": "The head branch name the changes are on."
},
"check_suite[head_sha]": {
"type": "string",
"description": "The SHA of the most recent commit for this check suite."
},
"check_suite[status]": {
"type": "string",
"description": "The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`."
},
"check_suite[conclusion]": {
"type": "string",
"description": "The summary conclusion for all check runs that are part of the check suite. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, `action_required` or `stale`. This value will be `null` until the check run has `completed`."
},
"check_suite[url]": {
"type": "string",
"description": "URL that points to the check suite API resource."
},
"check_suite[pull_requests]": {
"type": "array",
"description": "An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["completed", "requested", "rerequested"],
"examples": []
},
{
"name": "code_scanning_alert",
"description": "Activity related to code scanning alerts in a repository. The type of activity is specified in the action property of the payload object. For more information, see \"[About code scanning](https://docs.github.com/en/enterprise-server@3.3/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning).\"",
"properties": {
"alert": {
"type": "object",
"description": "The code scanning alert involved in the event."
},
"ref": {
"type": "string",
"description": "The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty."
},
"commit_oid": {
"type": "string",
"description": "The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "If the `action` is `reopened_by_user` or `closed_by_user`, the `sender` object will be the user that triggered the event. The `sender` object is `github-enterprise` for all other actions."
}
},
"actions": [
"appeared_in_branch",
"closed_by_user",
"created",
"fixed",
"reopened",
"reopened_by_user"
],
"examples": []
},
{
"name": "commit_comment",
"description": "A commit comment is created. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[commit comment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#comments)\" REST API.",
"properties": {
"comment": {
"type": "object",
"description": "The [commit comment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/commits#get-a-commit-comment) resource."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created"],
"examples": []
},
{
"name": "content_reference",
"description": "A new content reference is `created`. A new content reference is created when the body or comment of an issue or pull request includes a URL that matches a configured content reference domain. For more information, see \"[Using content attachments](https://docs.github.com/en/enterprise-server@3.3/apps/using-content-attachments)\" to learn more about content references and attachments.\n\nWebhook events are triggered based on the specificity of the domain you register. For example, if you register a subdomain (`https://subdomain.example.com`) then only URLs for the subdomain trigger this event. If you register a domain (`https://example.com`) then URLs for domain and all subdomains trigger this event. See \"[Create a content attachment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/apps#create-a-content-attachment)\" to create a new content attachment.",
"properties": {},
"actions": [],
"examples": []
},
{
"name": "create",
"description": "A Git branch or tag is created. For more information, see the \"[Git database](https://docs.github.com/en/enterprise-server@3.3/rest/reference/git#create-a-reference)\" REST API.",
"properties": {
"ref": {
"type": "string",
"description": "The [`git ref`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/git#get-a-reference) resource."
},
"ref_type": {
"type": "string",
"description": "The type of Git ref object created in the repository. Can be either `branch` or `tag`."
},
"master_branch": {
"type": "string",
"description": "The name of the repository's default branch (usually `main`)."
},
"description": {
"type": "string",
"description": "The repository's current description."
},
"pusher_type": {
"type": "string",
"description": "The pusher type for the event. Can be either `user` or a deploy key."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [],
"examples": []
},
{
"name": "delete",
"description": "A Git branch or tag is deleted. For more information, see the \"[Git database](https://docs.github.com/en/enterprise-server@3.3/rest/reference/git#delete-a-reference)\" REST API.",
"properties": {
"ref": {
"type": "string",
"description": "The [`git ref`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/git#get-a-reference) resource."
},
"ref_type": {
"type": "string",
"description": "The type of Git ref oject deleted in the repository. Can be `branch` or `tag`."
},
"pusher_type": {
"type": "string",
"description": "The pusher type for the event. Can be either `user` or a deploy key."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [],
"examples": []
},
{
"name": "deploy_key",
"description": "A deploy key is added or removed from a repository. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[Deploy keys](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#keys)\" REST API.",
"properties": {
"key": {
"type": "object",
"description": "The [`deploy key`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/deployments#get-a-deploy-key) resource."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created", "deleted"],
"examples": []
},
{
"name": "deployment",
"description": "A deployment is created. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[deployment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/deployments#list-deployments)\" REST API.",
"properties": {
"deployment": {
"type": "object",
"description": "The [deployment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/deployments#list-deployments)."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created"],
"examples": []
},
{
"name": "deployment_status",
"description": "A deployment is created. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[deployments](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#deployments)\" REST API.",
"properties": {
"deployment_status": {
"type": "object",
"description": "The [deployment status](https://docs.github.com/en/enterprise-server@3.3/rest/reference/deployments#list-deployment-statuses)."
},
"deployment_status[\"state\"]": {
"type": "string",
"description": "The new state. Can be `pending`, `success`, `failure`, or `error`."
},
"deployment_status[\"target_url\"]": {
"type": "string",
"description": "The optional link added to the status."
},
"deployment_status[\"description\"]": {
"type": "string",
"description": "The optional human-readable description added to the status."
},
"deployment": {
"type": "object",
"description": "The [deployment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/deployments#list-deployments) that this status is associated with."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created"],
"examples": []
},
{
"name": "enterprise",
"description": "A site or repository administrator enables or disables anonymous Git read access. See \"[Allowing admins to enable anonymous Git read access to public repositories](https://docs.github.com/en/enterprise-server@3.3/admin/user-management/allowing-admins-to-enable-anonymous-git-read-access-to-public-repositories)\" for more details. This event is not available in the Events API.",
"properties": {},
"actions": ["anonymous_access_disabled", "anonymous_access_enabled"],
"examples": []
},
{
"name": "fork",
"description": "A user forks a repository. For more information, see the \"[forks](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#forks)\" REST API.",
"properties": {
"forkee": {
"type": "object",
"description": "The created [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) resource."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [],
"examples": []
},
{
"name": "github_app_authorization",
"description": "When someone revokes their authorization of a GitHub App, this event occurs. A GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about user-to-server requests, which require GitHub App authorization, see \"[Identifying and authorizing users for GitHub Apps](https://docs.github.com/en/enterprise-server@3.3/apps/building-github-apps/identifying-and-authorizing-users-for-github-apps).\"",
"properties": {
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["revoked"],
"examples": []
},
{
"name": "gollum",
"description": "A wiki page is created or updated. For more information, see \"[About wikis](https://docs.github.com/en/enterprise-server@3.3/communities/documenting-your-project-with-wikis/about-wikis).\"",
"properties": {
"pages": {
"type": "array",
"description": "The pages that were updated."
},
"pages[][page_name]": {
"type": "string",
"description": "The name of the page."
},
"pages[][title]": {
"type": "string",
"description": "The current page title."
},
"pages[][action]": {
"type": "string",
"description": "The action that was performed on the page. Can be `created` or `edited`."
},
"pages[][sha]": {
"type": "string",
"description": "The latest commit SHA of the page."
},
"pages[][html_url]": {
"type": "string",
"description": "Points to the HTML wiki page."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [],
"examples": []
},
{
"name": "installation",
"description": "Activity related to a GitHub App installation. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[GitHub App installation](https://docs.github.com/en/enterprise-server@3.3/rest/reference/apps)\" REST API.",
"properties": {
"repositories": {
"type": "array",
"description": "An array of repository objects that the installation can access."
},
"installation": {
"type": "object",
"description": "The GitHub App installation."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [
"created",
"deleted",
"new_permissions_accepted",
"suspend",
"unsuspend"
],
"examples": []
},
{
"name": "installation_repositories",
"description": "Activity related to repositories being added to a GitHub App installation. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[GitHub App installation](https://docs.github.com/en/enterprise-server@3.3/rest/reference/apps)\" REST API.",
"properties": {
"repository_selection": {
"type": "string",
"description": "The choice of repositories the installation is on. Can be either `selected` or `all`."
},
"repositories_added": {
"type": "array",
"description": "An array of repository objects, which were added to the installation."
},
"repositories_removed": {
"type": "array",
"description": "An array of repository objects, which were removed from the installation."
},
"installation": {
"type": "object",
"description": "The GitHub App installation."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["added", "removed"],
"examples": []
},
{
"name": "issue_comment",
"description": "Activity related to an issue or pull request comment. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[issue comments](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues#comments)\" REST API.",
"properties": {
"changes": {
"type": "object",
"description": "The changes to the comment if the action was `edited`."
},
"changes[body][from]": {
"type": "string",
"description": "The previous version of the body if the action was `edited`."
},
"issue": {
"type": "object",
"description": "The [issue](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues) the comment belongs to."
},
"comment": {
"type": "object",
"description": "The [comment](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues#comments) itself."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created", "deleted", "edited"],
"examples": []
},
{
"name": "issues",
"description": "Activity related to an issue. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[issues](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues)\" REST API.",
"properties": {
"issue": {
"type": "object",
"description": "The [issue](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues) itself."
},
"changes": {
"type": "object",
"description": "The changes to the issue if the action was `edited`."
},
"changes[title][from]": {
"type": "string",
"description": "The previous version of the title if the action was `edited`."
},
"changes[body][from]": {
"type": "string",
"description": "The previous version of the body if the action was `edited`."
},
"assignee": {
"type": "object",
"description": "The optional user who was assigned or unassigned from the issue."
},
"label": {
"type": "object",
"description": "The optional label that was added or removed from the issue."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [
"assigned",
"closed",
"deleted",
"demilestoned",
"edited",
"labeled",
"locked",
"milestoned",
"opened",
"pinned",
"reopened",
"transferred",
"unassigned",
"unlabeled",
"unlocked",
"unpinned"
],
"examples": []
},
{
"name": "label",
"description": "Activity related to a label. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[labels](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues#labels)\" REST API.",
"properties": {
"label": { "type": "object", "description": "The label that was added." },
"changes": {
"type": "object",
"description": "The changes to the label if the action was `edited`."
},
"changes[name][from]": {
"type": "string",
"description": "The previous version of the name if the action was `edited`."
},
"changes[color][from]": {
"type": "string",
"description": "The previous version of the color if the action was `edited`."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["created", "deleted", "edited"],
"examples": []
},
{
"name": "member",
"description": "Activity related to repository collaborators. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[collaborators](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#collaborators)\" REST API.",
"properties": {
"member": {
"type": "object",
"description": "The [user](https://docs.github.com/en/enterprise-server@3.3/rest/reference/users) that was added."
},
"changes": {
"type": "object",
"description": "The changes to the collaborator permissions if the action was `edited`."
},
"changes[old_permission][from]": {
"type": "string",
"description": "The previous permissions of the collaborator if the action was `edited`."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["added", "edited", "removed"],
"examples": []
},
{
"name": "membership",
"description": "Activity related to team membership. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[team members](https://docs.github.com/en/enterprise-server@3.3/rest/reference/teams#members)\" REST API.",
"properties": {
"scope": {
"type": "string",
"description": "The scope of the membership. Currently, can only be `team`."
},
"member": {
"type": "object",
"description": "The [user](https://docs.github.com/en/enterprise-server@3.3/rest/reference/users) that was added or removed."
},
"team": {
"type": "object",
"description": "The [team](https://docs.github.com/en/enterprise-server@3.3/rest/reference/teams) for the membership."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["added", "removed"],
"examples": []
},
{
"name": "meta",
"description": "The webhook this event is configured on was deleted. This event will only listen for changes to the particular hook the event is installed on. Therefore, it must be selected for each hook that you'd like to receive meta events for.",
"properties": {
"hook_id": {
"type": "integer",
"description": "The id of the modified webhook."
},
"hook": {
"type": "object",
"description": "The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["deleted"],
"examples": []
},
{
"name": "milestone",
"description": "Activity related to milestones. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[milestones](https://docs.github.com/en/enterprise-server@3.3/rest/reference/issues#milestones)\" REST API.",
"properties": {
"milestone": { "type": "object", "description": "The milestone itself." },
"changes": {
"type": "object",
"description": "The changes to the milestone if the action was `edited`."
},
"changes[description][from]": {
"type": "string",
"description": "The previous version of the description if the action was `edited`."
},
"changes[due_on][from]": {
"type": "string",
"description": "The previous version of the due date if the action was `edited`."
},
"changes[title][from]": {
"type": "string",
"description": "The previous version of the title if the action was `edited`."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["closed", "created", "deleted", "edited", "opened"],
"examples": []
},
{
"name": "organization",
"description": "Activity related to an organization and its members. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[organizations](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs)\" REST API.",
"properties": {
"invitation": {
"type": "object",
"description": "The invitation for the user or email if the action is `member_invited`."
},
"membership": {
"type": "object",
"description": "The membership between the user and the organization. Not present when the action is `member_invited`."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [
"created",
"deleted",
"member_added",
"member_invited",
"member_removed",
"renamed"
],
"examples": []
},
{
"name": "package",
"description": "Activity related to GitHub Packages. The type of activity is specified in the `action` property of the payload object. For more information, see \"[Managing packages with GitHub Packages](https://docs.github.com/en/enterprise-server@3.3/github/managing-packages-with-github-packages)\" to learn more about GitHub Packages.",
"properties": {
"package": {
"type": "object",
"description": "Information about the package."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["published", "updated"],
"examples": []
},
{
"name": "page_build",
"description": "Represents an attempted build of a GitHub Pages site, whether successful or not. A push to a GitHub Pages enabled branch (`gh-pages` for project pages, the default branch for user and organization pages) triggers this event.",
"properties": {
"id": {
"type": "integer",
"description": "The unique identifier of the page build."
},
"build": {
"type": "object",
"description": "The [List GitHub Pages builds](https://docs.github.com/en/enterprise-server@3.3/rest/reference/pages#list-github-pages-builds) itself."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [],
"examples": []
},
{
"name": "ping",
"description": "When you create a new webhook, we'll send you a simple `ping` event to let you know you've set up the webhook correctly. This event isn't stored so it isn't retrievable via the [Events API](https://docs.github.com/en/enterprise-server@3.3/rest/reference/activity#ping-a-repository-webhook) endpoint.",
"properties": {
"zen": {
"type": "string",
"description": "Random string of GitHub zen."
},
"hook_id": {
"type": "integer",
"description": "The ID of the webhook that triggered the ping."
},
"hook": {
"type": "object",
"description": "The [webhook configuration](https://docs.github.com/en/enterprise-server@3.3/rest/reference/webhooks#get-a-repository-webhook)."
},
"hook[app_id]": {
"type": "integer",
"description": "When you register a new GitHub App, GitHub Enterprise Server sends a ping event to the **webhook URL** you specified during registration. The event contains the `app_id`, which is required for [authenticating](https://docs.github.com/en/enterprise-server@3.3/apps/building-integrations/setting-up-and-registering-github-apps/about-authentication-options-for-github-apps) an app."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": [],
"examples": []
},
{
"name": "project",
"description": "Activity related to project boards. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[projects](https://docs.github.com/en/enterprise-server@3.3/rest/reference/projects)\" REST API.",
"properties": {
"changes": {
"type": "object",
"description": "The changes to the project if the action was `edited`."
},
"changes[name][from]": {
"type": "string",
"description": "The previous version of the name if the action was `edited`."
},
"changes[body][from]": {
"type": "string",
"description": "The previous version of the body if the action was `edited`."
},
"project": {
"type": "object",
"description": "The [project](https://docs.github.com/en/enterprise-server@3.3/rest/reference/projects) itself."
},
"repository": {
"type": "object",
"description": "The [`repository`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/repos#get-a-repository) where the event occurred."
},
"organization": {
"type": "object",
"description": "Webhook payloads contain the [`organization`](https://docs.github.com/en/enterprise-server@3.3/rest/reference/orgs#get-an-organization) object when the webhook is configured for an organization or the event occurs from activity in a repository owned by an organization."
},
"installation": {
"type": "object",
"description": "The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App."
},
"sender": {
"type": "object",
"description": "The user that triggered the event."
}
},
"actions": ["closed", "created", "deleted", "edited", "reopened"],
"examples": []
},
{
"name": "project_card",
"description": "Activity related to project cards. The type of activity is specified in the `action` property of the payload object. For more information, see the \"[project cards](https://docs.github.com/en/enterprise-server@3.3/rest/reference/projects#cards)\" REST API.",
"properties": {
"changes": {
"type": "object",
"description": "The changes to the project card if the action was `edited` or `converted`."
},
"changes[note][from]": {
"type": "string",