Skip to content

Commit 0ec1574

Browse files
Octokit Botgr2m
Octokit Bot
authored and
gr2m
committed
build: known webhooks
1 parent d9996b3 commit 0ec1574

File tree

3 files changed

+172
-7
lines changed

3 files changed

+172
-7
lines changed

‎README.md‎

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -508,6 +508,7 @@ If there are actions for a webhook, events are emitted for both, the webhook nam
508508
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#contentreferenceevent"><code>content_reference</code></a></td><td class="actions-td td_num"></td></tr>
509509
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#createevent"><code>create</code></a></td><td class="actions-td td_num"></td></tr>
510510
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#deleteevent"><code>delete</code></a></td><td class="actions-td td_num"></td></tr>
511+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#deploykeyevent"><code>deploy_key</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code></td></tr>
511512
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#deploymentevent"><code>deployment</code></a></td><td class="actions-td td_num"></td></tr>
512513
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#deploymentstatusevent"><code>deployment_status</code></a></td><td class="actions-td td_num"></td></tr>
513514
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#forkevent"><code>fork</code></a></td><td class="actions-td td_num"></td></tr>
@@ -516,28 +517,30 @@ If there are actions for a webhook, events are emitted for both, the webhook nam
516517
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#installationevent"><code>installation</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>new_permissions_accepted</code></td></tr>
517518
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#installationrepositoriesevent"><code>installation_repositories</code></a></td><td class="actions-td td_text"><code>added</code><br><code>removed</code></td></tr>
518519
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#issuecommentevent"><code>issue_comment</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>edited</code></td></tr>
519-
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#issuesevent"><code>issues</code></a></td><td class="actions-td td_text"><code>assigned</code><br><code>closed</code><br><code>deleted</code><br><code>demilestoned</code><br><code>edited</code><br><code>labeled</code><br><code>milestoned</code><br><code>opened</code><br><code>pinned</code><br><code>reopened</code><br><code>transferred</code><br><code>unassigned</code><br><code>unlabeled</code><br><code>unpinned</code></td></tr>
520+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#issuesevent"><code>issues</code></a></td><td class="actions-td td_text"><code>assigned</code><br><code>closed</code><br><code>deleted</code><br><code>demilestoned</code><br><code>edited</code><br><code>labeled</code><br><code>locked</code><br><code>milestoned</code><br><code>opened</code><br><code>pinned</code><br><code>reopened</code><br><code>transferred</code><br><code>unassigned</code><br><code>unlabeled</code><br><code>unlocked</code><br><code>unpinned</code></td></tr>
520521
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#labelevent"><code>label</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>edited</code></td></tr>
521522
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#marketplacepurchaseevent"><code>marketplace_purchase</code></a></td><td class="actions-td td_text"><code>cancelled</code><br><code>changed</code><br><code>pending_change</code><br><code>pending_change_cancelled</code><br><code>purchased</code></td></tr>
522523
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#memberevent"><code>member</code></a></td><td class="actions-td td_text"><code>added</code><br><code>deleted</code><br><code>edited</code></td></tr>
523524
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#membershipevent"><code>membership</code></a></td><td class="actions-td td_text"><code>added</code><br><code>removed</code></td></tr>
525+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#metaevent"><code>meta</code></a></td><td class="actions-td td_text"><code>deleted</code></td></tr>
524526
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#milestoneevent"><code>milestone</code></a></td><td class="actions-td td_text"><code>closed</code><br><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>opened</code></td></tr>
525-
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#organizationevent"><code>organization</code></a></td><td class="actions-td td_text"><code>member_added</code><br><code>member_invited</code><br><code>member_removed</code></td></tr>
527+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#organizationevent"><code>organization</code></a></td><td class="actions-td td_text"><code>deleted</code><br><code>member_added</code><br><code>member_invited</code><br><code>member_removed</code><br><code>renamed</code></td></tr>
526528
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#orgblockevent"><code>org_block</code></a></td><td class="actions-td td_text"><code>blocked</code><br><code>unblocked</code></td></tr>
527529
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pagebuildevent"><code>page_build</code></a></td><td class="actions-td td_num"></td></tr>
528530
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#projectcardevent"><code>project_card</code></a></td><td class="actions-td td_text"><code>converted</code><br><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>moved</code></td></tr>
529531
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#projectcolumnevent"><code>project_column</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>moved</code></td></tr>
530532
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#projectevent"><code>project</code></a></td><td class="actions-td td_text"><code>closed</code><br><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>reopened</code></td></tr>
531533
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#publicevent"><code>public</code></a></td><td class="actions-td td_num"></td></tr>
532-
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pullrequestevent"><code>pull_request</code></a></td><td class="actions-td td_text"><code>assigned</code><br><code>closed</code><br><code>edited</code><br><code>labeled</code><br><code>opened</code><br><code>ready_for_review</code><br><code>reopened</code><br><code>review_request_removed</code><br><code>review_requested</code><br><code>unassigned</code><br><code>unlabeled</code><br><code>synchronize</code></td></tr>
534+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pullrequestevent"><code>pull_request</code></a></td><td class="actions-td td_text"><code>assigned</code><br><code>closed</code><br><code>edited</code><br><code>labeled</code><br><code>locked</code><br><code>opened</code><br><code>ready_for_review</code><br><code>reopened</code><br><code>review_request_removed</code><br><code>review_requested</code><br><code>unassigned</code><br><code>unlabeled</code><br><code>unlocked</code><br><code>synchronize</code></td></tr>
533535
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pullrequestreviewevent"><code>pull_request_review</code></a></td><td class="actions-td td_text"><code>dismissed</code><br><code>edited</code><br><code>submitted</code></td></tr>
534536
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pullrequestreviewcommentevent"><code>pull_request_review_comment</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>edited</code></td></tr>
535537
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#pushevent"><code>push</code></a></td><td class="actions-td td_num"></td></tr>
536-
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#releaseevent"><code>release</code></a></td><td class="actions-td td_text"><code>published</code></td></tr>
537-
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryevent"><code>repository</code></a></td><td class="actions-td td_text"><code>archived</code><br><code>created</code><br><code>deleted</code><br><code>privatized</code><br><code>publicized</code><br><code>unarchived</code></td></tr>
538+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#releaseevent"><code>release</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>prereleased</code><br><code>published</code><br><code>unpublished</code></td></tr>
539+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryevent"><code>repository</code></a></td><td class="actions-td td_text"><code>archived</code><br><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>privatized</code><br><code>publicized</code><br><code>renamed</code><br><code>transferred</code><br><code>unarchived</code></td></tr>
538540
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryimportevent"><code>repository_import</code></a></td><td class="actions-td td_num"></td></tr>
539541
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#repositoryvulnerabilityalertevent"><code>repository_vulnerability_alert</code></a></td><td class="actions-td td_text"><code>create</code><br><code>dismiss</code><br><code>resolve</code></td></tr>
540542
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#securityadvisoryevent"><code>security_advisory</code></a></td><td class="actions-td td_text"><code>performed</code><br><code>published</code><br><code>updated</code></td></tr>
543+
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#starevent"><code>star</code></a></td><td class="actions-td td_text"><code>created</code><br><code>deleted</code></td></tr>
541544
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#statusevent"><code>status</code></a></td><td class="actions-td td_num"></td></tr>
542545
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#teamevent"><code>team</code></a></td><td class="actions-td td_text"><code>added_to_repository</code><br><code>created</code><br><code>deleted</code><br><code>edited</code><br><code>removed_from_repository</code></td></tr>
543546
<tr ><td class="name-td td_text"><a href="https://developer.github.com/v3/activity/events/types/#teamaddevent"><code>team_add</code></a></td><td class="actions-td td_num"></td></tr>

‎index.d.ts‎

Lines changed: 142 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,6 +264,32 @@ declare namespace Webhooks {
264264
repository: PayloadRepository;
265265
sender: WebhookPayloadStatusSender;
266266
};
267+
type WebhookPayloadStarSender = {
268+
login: string;
269+
id: number;
270+
node_id: string;
271+
avatar_url: string;
272+
gravatar_id: string;
273+
url: string;
274+
html_url: string;
275+
followers_url: string;
276+
following_url: string;
277+
gists_url: string;
278+
starred_url: string;
279+
subscriptions_url: string;
280+
organizations_url: string;
281+
repos_url: string;
282+
events_url: string;
283+
received_events_url: string;
284+
type: string;
285+
site_admin: boolean;
286+
};
287+
type WebhookPayloadStar = {
288+
action: string;
289+
starred_at: string;
290+
repository: PayloadRepository;
291+
sender: WebhookPayloadStarSender;
292+
};
267293
type WebhookPayloadSecurityAdvisorySecurityAdvisoryVulnerabilitiesItemFirstPatchedVersion = {
268294
identifier: string;
269295
};
@@ -2096,6 +2122,48 @@ declare namespace Webhooks {
20962122
repository: PayloadRepository;
20972123
sender: WebhookPayloadMilestoneSender;
20982124
};
2125+
type WebhookPayloadMetaSender = {
2126+
login: string;
2127+
id: number;
2128+
node_id: string;
2129+
avatar_url: string;
2130+
gravatar_id: string;
2131+
url: string;
2132+
html_url: string;
2133+
followers_url: string;
2134+
following_url: string;
2135+
gists_url: string;
2136+
starred_url: string;
2137+
subscriptions_url: string;
2138+
organizations_url: string;
2139+
repos_url: string;
2140+
events_url: string;
2141+
received_events_url: string;
2142+
type: string;
2143+
site_admin: boolean;
2144+
};
2145+
type WebhookPayloadMetaHookConfig = {
2146+
content_type: string;
2147+
insecure_ssl: string;
2148+
url: string;
2149+
};
2150+
type WebhookPayloadMetaHook = {
2151+
type: string;
2152+
id: number;
2153+
name: string;
2154+
active: boolean;
2155+
events: Array<string>;
2156+
config: WebhookPayloadMetaHookConfig;
2157+
updated_at: string;
2158+
created_at: string;
2159+
};
2160+
type WebhookPayloadMeta = {
2161+
action: string;
2162+
hook_id: number;
2163+
hook: WebhookPayloadMetaHook;
2164+
repository: PayloadRepository;
2165+
sender: WebhookPayloadMetaSender;
2166+
};
20992167
type WebhookPayloadMembershipOrganization = {
21002168
login: string;
21012169
id: number;
@@ -2985,6 +3053,41 @@ declare namespace Webhooks {
29853053
repository: PayloadRepository;
29863054
sender: WebhookPayloadDeploymentSender;
29873055
};
3056+
type WebhookPayloadDeployKeySender = {
3057+
login: string;
3058+
id: number;
3059+
node_id: string;
3060+
avatar_url: string;
3061+
gravatar_id: string;
3062+
url: string;
3063+
html_url: string;
3064+
followers_url: string;
3065+
following_url: string;
3066+
gists_url: string;
3067+
starred_url: string;
3068+
subscriptions_url: string;
3069+
organizations_url: string;
3070+
repos_url: string;
3071+
events_url: string;
3072+
received_events_url: string;
3073+
type: string;
3074+
site_admin: boolean;
3075+
};
3076+
type WebhookPayloadDeployKeyKey = {
3077+
id: number;
3078+
key: string;
3079+
url: string;
3080+
title: string;
3081+
verified: boolean;
3082+
created_at: string;
3083+
read_only: boolean;
3084+
};
3085+
type WebhookPayloadDeployKey = {
3086+
action: string;
3087+
key: WebhookPayloadDeployKeyKey;
3088+
repository: PayloadRepository;
3089+
sender: WebhookPayloadDeployKeySender;
3090+
};
29883091
type WebhookPayloadDeleteSender = {
29893092
login: string;
29903093
id: number;
@@ -3557,6 +3660,13 @@ declare class Webhooks {
35573660
) => Promise<void> | void
35583661
): void;
35593662

3663+
public on(
3664+
event: "deploy_key" | "deploy_key.created" | "deploy_key.deleted",
3665+
callback: (
3666+
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadDeployKey>
3667+
) => Promise<void> | void
3668+
): void;
3669+
35603670
public on(
35613671
event: "deployment",
35623672
callback: (
@@ -3637,13 +3747,15 @@ declare class Webhooks {
36373747
| "issues.demilestoned"
36383748
| "issues.edited"
36393749
| "issues.labeled"
3750+
| "issues.locked"
36403751
| "issues.milestoned"
36413752
| "issues.opened"
36423753
| "issues.pinned"
36433754
| "issues.reopened"
36443755
| "issues.transferred"
36453756
| "issues.unassigned"
36463757
| "issues.unlabeled"
3758+
| "issues.unlocked"
36473759
| "issues.unpinned",
36483760
callback: (
36493761
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadIssues>
@@ -3684,6 +3796,13 @@ declare class Webhooks {
36843796
) => Promise<void> | void
36853797
): void;
36863798

3799+
public on(
3800+
event: "meta" | "meta.deleted",
3801+
callback: (
3802+
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadMeta>
3803+
) => Promise<void> | void
3804+
): void;
3805+
36873806
public on(
36883807
event:
36893808
| "milestone"
@@ -3700,9 +3819,11 @@ declare class Webhooks {
37003819
public on(
37013820
event:
37023821
| "organization"
3822+
| "organization.deleted"
37033823
| "organization.member_added"
37043824
| "organization.member_invited"
3705-
| "organization.member_removed",
3825+
| "organization.member_removed"
3826+
| "organization.renamed",
37063827
callback: (
37073828
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadOrganization>
37083829
) => Promise<void> | void
@@ -3774,13 +3895,15 @@ declare class Webhooks {
37743895
| "pull_request.closed"
37753896
| "pull_request.edited"
37763897
| "pull_request.labeled"
3898+
| "pull_request.locked"
37773899
| "pull_request.opened"
37783900
| "pull_request.ready_for_review"
37793901
| "pull_request.reopened"
37803902
| "pull_request.review_request_removed"
37813903
| "pull_request.review_requested"
37823904
| "pull_request.unassigned"
37833905
| "pull_request.unlabeled"
3906+
| "pull_request.unlocked"
37843907
| "pull_request.synchronize",
37853908
callback: (
37863909
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadPullRequest>
@@ -3819,7 +3942,14 @@ declare class Webhooks {
38193942
): void;
38203943

38213944
public on(
3822-
event: "release" | "release.published",
3945+
event:
3946+
| "release"
3947+
| "release.created"
3948+
| "release.deleted"
3949+
| "release.edited"
3950+
| "release.prereleased"
3951+
| "release.published"
3952+
| "release.unpublished",
38233953
callback: (
38243954
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadRelease>
38253955
) => Promise<void> | void
@@ -3831,8 +3961,11 @@ declare class Webhooks {
38313961
| "repository.archived"
38323962
| "repository.created"
38333963
| "repository.deleted"
3964+
| "repository.edited"
38343965
| "repository.privatized"
38353966
| "repository.publicized"
3967+
| "repository.renamed"
3968+
| "repository.transferred"
38363969
| "repository.unarchived",
38373970
callback: (
38383971
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadRepository>
@@ -3870,6 +4003,13 @@ declare class Webhooks {
38704003
) => Promise<void> | void
38714004
): void;
38724005

4006+
public on(
4007+
event: "star" | "star.created" | "star.deleted",
4008+
callback: (
4009+
event: Webhooks.WebhookEvent<Webhooks.WebhookPayloadStar>
4010+
) => Promise<void> | void
4011+
): void;
4012+
38734013
public on(
38744014
event: "status",
38754015
callback: (

0 commit comments

Comments
 (0)