Webhook map
branchcreated(branch.created)deleted(branch.deleted)
checkRuncompleted(checkRun.completed)created(checkRun.created)rerequested(checkRun.rerequested)
checkSuitecompleted(checkSuite.completed)requested(checkSuite.requested)
commentcreated(comment.created)deleted(comment.deleted)edited(comment.edited)
dependabotAlertautoDismissed(dependabotAlert.autoDismissed)autoReopened(dependabotAlert.autoReopened)created(dependabotAlert.created)dismissed(dependabotAlert.dismissed)fixed(dependabotAlert.fixed)reopened(dependabotAlert.reopened)
deploymentcreated(deployment.created)
deploymentStatuscreated(deploymentStatus.created)
discussionanswered(discussion.answered)closed(discussion.closed)created(discussion.created)deleted(discussion.deleted)edited(discussion.edited)reopened(discussion.reopened)
discussionCommentcreated(discussionComment.created)deleted(discussionComment.deleted)edited(discussionComment.edited)
forkforked(fork.forked)
issueassigned(issue.assigned)closed(issue.closed)deleted(issue.deleted)edited(issue.edited)labeled(issue.labeled)locked(issue.locked)opened(issue.opened)pinned(issue.pinned)reopened(issue.reopened)transferred(issue.transferred)unassigned(issue.unassigned)unlabeled(issue.unlabeled)unlocked(issue.unlocked)unpinned(issue.unpinned)
labelcreated(label.created)deleted(label.deleted)edited(label.edited)
memberadded(member.added)removed(member.removed)
membershipadded(membership.added)removed(membership.removed)
milestoneclosed(milestone.closed)created(milestone.created)deleted(milestone.deleted)edited(milestone.edited)opened(milestone.opened)
pullRequestclosed(pullRequest.closed)convertedToDraft(pullRequest.convertedToDraft)labeled(pullRequest.labeled)opened(pullRequest.opened)readyForReview(pullRequest.readyForReview)reopened(pullRequest.reopened)reviewRequested(pullRequest.reviewRequested)synchronize(pullRequest.synchronize)unlabeled(pullRequest.unlabeled)
pullRequestReviewdismissed(pullRequestReview.dismissed)edited(pullRequestReview.edited)submitted(pullRequestReview.submitted)
pullRequestReviewCommentcreated(pullRequestReviewComment.created)deleted(pullRequestReviewComment.deleted)edited(pullRequestReviewComment.edited)
pullRequestReviewThreadresolved(pullRequestReviewThread.resolved)unresolved(pullRequestReviewThread.unresolved)
push(push)releasecreated(release.created)deleted(release.deleted)edited(release.edited)prereleased(release.prereleased)published(release.published)released(release.released)unpublished(release.unpublished)
repositoryarchived(repository.archived)created(repository.created)deleted(repository.deleted)privatized(repository.privatized)publicized(repository.publicized)renamed(repository.renamed)transferred(repository.transferred)unarchived(repository.unarchived)
starcreated(star.created)deleted(star.deleted)
tagcreated(tag.created)deleted(tag.deleted)
watchstarted(watch.started)
workflowDispatchdispatched(workflowDispatch.dispatched)
workflowJobcompleted(workflowJob.completed)inProgress(workflowJob.inProgress)queued(workflowJob.queued)waiting(workflowJob.waiting)
workflowRuncompleted(workflowRun.completed)inProgress(workflowRun.inProgress)requested(workflowRun.requested)
HTTP handler setup
import { processWebhook } from "corsair";
import { corsair } from "@/server/corsair";
export async function POST(request: Request) {
const headers = Object.fromEntries(request.headers);
const body = await request.json();
const result = await processWebhook(corsair, headers, body);
return result.response;
}
Events
Branch
Created
branch.created
A branch was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
ref | string | Yes | — |
ref_type | branch | Yes | — |
master_branch | string | Yes | — |
description | string | No | — |
pusher_type | string | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
ref: string,
ref_type: branch,
master_branch: string,
description?: string | null,
pusher_type: string,
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
branch: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deleted
branch.deleted
A branch was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
ref | string | Yes | — |
ref_type | branch | Yes | — |
pusher_type | string | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
ref: string,
ref_type: branch,
pusher_type: string,
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
branch: {
deleted: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Check Run
Completed
checkRun.completed
A check run completed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | completed | Yes | — |
check_run | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
check_run full type
check_run full type
{
id: number,
node_id: string,
head_sha: string,
external_id?: string | null,
url: string,
html_url?: string | null,
details_url?: string | null,
status: queued | in_progress | completed,
conclusion?: string | null,
started_at?: string | null,
completed_at?: string | null,
name: string,
check_suite?: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string
} | null,
app?: any | null,
pull_requests: any[]
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: completed,
check_run: {
id: number,
node_id: string,
head_sha: string,
external_id?: string | null,
url: string,
html_url?: string | null,
details_url?: string | null,
status: queued | in_progress | completed,
conclusion?: string | null,
started_at?: string | null,
completed_at?: string | null,
name: string,
check_suite?: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string
} | null,
app?: any | null,
pull_requests: any[]
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
checkRun: {
completed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Created
checkRun.created
A check run was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
check_run | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
check_run full type
check_run full type
{
id: number,
node_id: string,
head_sha: string,
external_id?: string | null,
url: string,
html_url?: string | null,
details_url?: string | null,
status: queued | in_progress | completed,
conclusion?: string | null,
started_at?: string | null,
completed_at?: string | null,
name: string,
check_suite?: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string
} | null,
app?: any | null,
pull_requests: any[]
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
check_run: {
id: number,
node_id: string,
head_sha: string,
external_id?: string | null,
url: string,
html_url?: string | null,
details_url?: string | null,
status: queued | in_progress | completed,
conclusion?: string | null,
started_at?: string | null,
completed_at?: string | null,
name: string,
check_suite?: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string
} | null,
app?: any | null,
pull_requests: any[]
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
checkRun: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Rerequested
checkRun.rerequested
A check run was re-requested
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | rerequested | Yes | — |
check_run | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
check_run full type
check_run full type
{
id: number,
node_id: string,
head_sha: string,
external_id?: string | null,
url: string,
html_url?: string | null,
details_url?: string | null,
status: queued | in_progress | completed,
conclusion?: string | null,
started_at?: string | null,
completed_at?: string | null,
name: string,
check_suite?: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string
} | null,
app?: any | null,
pull_requests: any[]
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: rerequested,
check_run: {
id: number,
node_id: string,
head_sha: string,
external_id?: string | null,
url: string,
html_url?: string | null,
details_url?: string | null,
status: queued | in_progress | completed,
conclusion?: string | null,
started_at?: string | null,
completed_at?: string | null,
name: string,
check_suite?: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string
} | null,
app?: any | null,
pull_requests: any[]
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
checkRun: {
rerequested: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Check Suite
Completed
checkSuite.completed
A check suite completed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | completed | Yes | — |
check_suite | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
check_suite full type
check_suite full type
{
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string,
before?: string | null,
after?: string | null,
pull_requests: any[],
created_at: string,
updated_at: string,
app?: any | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: completed,
check_suite: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string,
before?: string | null,
after?: string | null,
pull_requests: any[],
created_at: string,
updated_at: string,
app?: any | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
checkSuite: {
completed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Requested
checkSuite.requested
A check suite was requested
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | requested | Yes | — |
check_suite | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
check_suite full type
check_suite full type
{
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string,
before?: string | null,
after?: string | null,
pull_requests: any[],
created_at: string,
updated_at: string,
app?: any | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: requested,
check_suite: {
id: number,
node_id: string,
head_branch?: string | null,
head_sha: string,
status?: string | null,
conclusion?: string | null,
url: string,
before?: string | null,
after?: string | null,
pull_requests: any[],
created_at: string,
updated_at: string,
app?: any | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
checkSuite: {
requested: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Comment
Created
comment.created
A comment was added to an issue or pull request
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
issue | object | Yes | — |
comment | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
comment full type
comment full type
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
comment: {
url: string,
html_url: string,
issue_url: string,
id: number,
node_id: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
author_association: string,
body: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
comment: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deleted
comment.deleted
A comment on an issue or pull request was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | deleted | Yes | — |
issue | object | Yes | — |
comment | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
comment full type
comment full type
{
url: string,
html_url: string,
issue_url: string,
id: number,
node_id: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
author_association: string,
body: string
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: deleted,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
comment: {
url: string,
html_url: string,
issue_url: string,
id: number,
node_id: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
author_association: string,
body: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
comment: {
deleted: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Edited
comment.edited
A comment on an issue or pull request was edited
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | edited | Yes | — |
issue | object | Yes | — |
comment | object | Yes | — |
changes | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
comment full type
comment full type
{
url: string,
html_url: string,
issue_url: string,
id: number,
node_id: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
author_association: string,
body: string
}
changes full type
changes full type
{
body?: {
from: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: edited,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
comment: {
url: string,
html_url: string,
issue_url: string,
id: number,
node_id: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
author_association: string,
body: string
},
changes?: {
body?: {
from: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
comment: {
edited: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Dependabot Alert
Auto Dismissed
dependabotAlert.autoDismissed
A Dependabot alert was auto-dismissed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | auto_dismissed | Yes | — |
alert | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
alert full type
alert full type
{
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: auto_dismissed,
alert: {
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
dependabotAlert: {
autoDismissed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Auto Reopened
dependabotAlert.autoReopened
A Dependabot alert was auto-reopened
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | auto_reopened | Yes | — |
alert | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
alert full type
alert full type
{
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: auto_reopened,
alert: {
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
dependabotAlert: {
autoReopened: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Created
dependabotAlert.created
A Dependabot alert was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
alert | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
alert full type
alert full type
{
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
alert: {
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
dependabotAlert: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Dismissed
dependabotAlert.dismissed
A Dependabot alert was dismissed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | dismissed | Yes | — |
alert | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
alert full type
alert full type
{
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: dismissed,
alert: {
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
dependabotAlert: {
dismissed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Fixed
dependabotAlert.fixed
A Dependabot alert was fixed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | fixed | Yes | — |
alert | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
alert full type
alert full type
{
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: fixed,
alert: {
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
dependabotAlert: {
fixed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Reopened
dependabotAlert.reopened
A Dependabot alert was reopened
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | reopened | Yes | — |
alert | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
alert full type
alert full type
{
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: reopened,
alert: {
number: number,
state: string,
dependency: {
package: {
ecosystem: string,
name: string
},
manifest_path: string,
scope?: string | null
},
security_advisory: {
ghsa_id: string,
cve_id?: string | null,
summary: string,
description: string,
severity: string,
identifiers: {
value: string,
type: string
}[],
references: {
url: string
}[],
published_at: string,
updated_at: string,
withdrawn_at?: string | null
},
security_vulnerability: {
package: {
ecosystem: string,
name: string
},
severity: string,
vulnerable_version_range: string,
first_patched_version?: {
identifier: string
} | null
},
url: string,
html_url: string,
created_at: string,
updated_at: string,
dismissed_at?: string | null,
dismissed_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
dismissed_reason?: string | null,
dismissed_comment?: string | null,
fixed_at?: string | null,
auto_dismissed_at?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
dependabotAlert: {
reopened: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deployment
Created
deployment.created
A deployment was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
deployment | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
deployment full type
deployment full type
{
url: string,
id: number,
node_id: string,
sha: string,
ref: string,
task: string,
environment: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
created_at: string,
updated_at: string,
statuses_url: string,
repository_url: string,
performed_via_github_app?: any | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
deployment: {
url: string,
id: number,
node_id: string,
sha: string,
ref: string,
task: string,
environment: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
created_at: string,
updated_at: string,
statuses_url: string,
repository_url: string,
performed_via_github_app?: any | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
deployment: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deployment Status
Created
deploymentStatus.created
A deployment status was updated
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
deployment | object | Yes | — |
deployment_status | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
deployment full type
deployment full type
{
url: string,
id: number,
node_id: string,
sha: string,
ref: string,
task: string,
environment: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
created_at: string,
updated_at: string,
statuses_url: string,
repository_url: string,
performed_via_github_app?: any | null
}
deployment_status full type
deployment_status full type
{
url: string,
id: number,
node_id: string,
state: error | failure | inactive | in_progress | queued | pending | success | waiting,
creator: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
description?: string | null,
environment?: string,
target_url?: string | null,
created_at: string,
updated_at: string,
deployment_url: string,
repository_url: string
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
deployment: {
url: string,
id: number,
node_id: string,
sha: string,
ref: string,
task: string,
environment: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
created_at: string,
updated_at: string,
statuses_url: string,
repository_url: string,
performed_via_github_app?: any | null
},
deployment_status: {
url: string,
id: number,
node_id: string,
state: error | failure | inactive | in_progress | queued | pending | success | waiting,
creator: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
description?: string | null,
environment?: string,
target_url?: string | null,
created_at: string,
updated_at: string,
deployment_url: string,
repository_url: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
deploymentStatus: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Discussion
Answered
discussion.answered
A discussion was answered
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | answered | Yes | — |
discussion | object | Yes | — |
answer | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
answer full type
answer full type
{
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: answered,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
answer: {
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussion: {
answered: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Closed
discussion.closed
A discussion was closed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | closed | Yes | — |
discussion | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: closed,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussion: {
closed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Created
discussion.created
A discussion was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
discussion | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussion: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deleted
discussion.deleted
A discussion was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | deleted | Yes | — |
discussion | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: deleted,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussion: {
deleted: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Edited
discussion.edited
A discussion was edited
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | edited | Yes | — |
discussion | object | Yes | — |
changes | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
changes full type
changes full type
{
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: edited,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
changes?: {
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussion: {
edited: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Reopened
discussion.reopened
A discussion was reopened
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | reopened | Yes | — |
discussion | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: reopened,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussion: {
reopened: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Discussion Comment
Created
discussionComment.created
A discussion comment was created
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | created | Yes | — |
discussion | object | Yes | — |
comment | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
comment full type
comment full type
{
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: created,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
comment: {
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussionComment: {
created: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deleted
discussionComment.deleted
A discussion comment was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | deleted | Yes | — |
discussion | object | Yes | — |
comment | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
comment full type
comment full type
{
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: deleted,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
comment: {
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussionComment: {
deleted: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Edited
discussionComment.edited
A discussion comment was edited
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | edited | Yes | — |
discussion | object | Yes | — |
comment | object | Yes | — |
changes | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
discussion full type
discussion full type
{
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
}
comment full type
comment full type
{
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
}
changes full type
changes full type
{
body?: {
from: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: edited,
discussion: {
repository_url: string,
category: {
id: number,
node_id: string,
repository_id: number,
emoji: string,
name: string,
description: string,
created_at: string,
updated_at: string,
slug: string,
is_answerable: boolean
},
answer_html_url?: string | null,
answer_chosen_at?: string | null,
answer_chosen_by?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
state: string,
locked: boolean,
comments: number,
created_at: string,
updated_at: string,
author_association: string,
active_lock_reason?: string | null,
body?: string | null
},
comment: {
id: number,
node_id: string,
html_url: string,
parent_id?: number | null,
child_comment_count: number,
repository_url: string,
discussion_id: number,
author_association: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
created_at: string,
updated_at: string,
body: string
},
changes?: {
body?: {
from: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
discussionComment: {
edited: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Fork
Forked
fork.forked
A repository was forked
Payload
| Name | Type | Required | Description |
|---|---|---|---|
forkee | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
forkee full type
forkee full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
forkee: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
fork: {
forked: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Issue
Assigned
issue.assigned
An issue was assigned
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | assigned | Yes | — |
issue | object | Yes | — |
assignee | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
assignee full type
assignee full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: assigned,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
assigned: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Closed
issue.closed
An issue was closed
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | closed | Yes | — |
issue | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: closed,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
closed: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Deleted
issue.deleted
An issue was deleted
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | deleted | Yes | — |
issue | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: deleted,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
deleted: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Edited
issue.edited
An issue was edited
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | edited | Yes | — |
issue | object | Yes | — |
changes | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
changes full type
changes full type
{
title?: {
from: string
},
body?: {
from: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: edited,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
changes?: {
title?: {
from: string
},
body?: {
from: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
edited: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Labeled
issue.labeled
A label was added to an issue
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | labeled | Yes | — |
issue | object | Yes | — |
label | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
label full type
label full type
{
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: labeled,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
label?: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
labeled: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Locked
issue.locked
An issue was locked
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | locked | Yes | — |
issue | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: true,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: locked,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: true,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
locked: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Opened
issue.opened
An issue was opened
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | opened | Yes | — |
issue | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: opened,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
opened: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Pinned
issue.pinned
An issue was pinned
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | pinned | Yes | — |
issue | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: pinned,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
pinned: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Reopened
issue.reopened
An issue was reopened
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | reopened | Yes | — |
issue | object | Yes | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: reopened,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
reopened: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Transferred
issue.transferred
An issue was transferred to another repository
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | transferred | Yes | — |
issue | object | Yes | — |
changes | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
changes full type
changes full type
{
new_issue?: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
new_repository?: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
Response data full type
Response data full type
{
action: transferred,
issue: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
changes?: {
new_issue?: {
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
},
new_repository?: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
},
repository: {
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
},
sender: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
installation?: {
id: number,
node_id: string
},
organization?: {
login: string,
id: number,
node_id: string,
url: string,
html_url?: string,
repos_url: string,
events_url: string,
hooks_url: string,
issues_url: string,
members_url: string,
public_members_url: string,
avatar_url: string,
description?: string | null
}
}
webhookHooks example
github({
webhookHooks: {
issue: {
transferred: {
before(ctx, args) {
return { ctx, args };
},
after(ctx, response) {
},
},
},
},
})
Unassigned
issue.unassigned
An issue was unassigned
Payload
| Name | Type | Required | Description |
|---|---|---|---|
action | unassigned | Yes | — |
issue | object | Yes | — |
assignee | object | No | — |
repository | object | Yes | — |
sender | object | Yes | — |
installation | object | No | — |
organization | object | No | — |
issue full type
issue full type
{
url: string,
repository_url: string,
html_url: string,
id: number,
node_id: string,
number: number,
title: string,
user: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
labels: {
id: number,
node_id: string,
url: string,
name: string,
color: string,
default: boolean,
description?: string | null
}[],
state: open | closed,
locked: boolean,
assignee?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
assignees: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}[],
milestone?: {
url: string,
html_url: string,
labels_url: string,
id: number,
node_id: string,
number: number,
title: string,
description?: string | null,
creator?: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
} | null,
open_issues: number,
closed_issues: number,
state: open | closed,
created_at: string,
updated_at: string,
due_on?: string | null,
closed_at?: string | null
} | null,
comments: number,
created_at: string,
updated_at: string,
closed_at?: string | null,
body?: string | null,
active_lock_reason?: string | null,
draft?: boolean,
pull_request?: {
url: string,
html_url: string,
diff_url: string,
patch_url: string
}
}
assignee full type
assignee full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
repository full type
repository full type
{
id: number,
node_id: string,
name: string,
full_name: string,
private: boolean,
owner: {
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
},
html_url: string,
description?: string | null,
fork: boolean,
url: string,
created_at: number | string,
updated_at: string,
pushed_at?: number | string | null,
default_branch: string
}
sender full type
sender full type
{
login: string,
id: number,
node_id: string,
name?: string,
email?: string | null,
avatar_url: string,
gravatar_id: string,
url: string,
html_url: string,
followers_url: string,
following_url: string,
gists_url: string,
starred_url: string,
subscriptions_url: string,
organizations_url: string,
repos_url: string,
events_url: string,
received_events_url: string,
type: Bot | User | Organization,
site_admin: boolean
}
installation full type
installation full type
{
id: number,
node_id: string
}
organization full type
organization full type
{
login: string,
id: number,
nod