GitHub webhook events
76 GitHub event types in 11 resources. 61 have sample payloads.
Every event here can also reach agents as an MCP event through Hookdeck: MCP events →
checks
check_run
documented from GitHub docs (example)
check_run Check run created, completed or re-requested
Identified by x-github-event header and action field in the body
Resource checks
{
"action": "created",
"check_run": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
check_suite
documented from GitHub docs (example)
check_suite Check suite requested, re-requested or completed
Identified by x-github-event header and action field in the body
Resource checks
{
"action": "completed",
"check_suite": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
merge_group
documented from GitHub docs (example)
merge_group Merge queue group requests checks or is destroyed
Identified by x-github-event header and action field in the body
Resource checks
{
"action": "checks_requested",
"merge_group": { … },
"repository": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
status
documented from GitHub docs (example)
status A Git commit's status changes
Identified by x-github-event header and action field in the body
Resource checks
{
"id": 6805126730,
"sha": "6113728f27ae82c7b1a177c8d03f9e96e0adf246",
"name": "Codertocat/Hello-World",
"target_url": null,
"context": "default",
"description": null,
"state": "success",
"commit": { … },
"branches": [ … ],
"created_at": "2019-05-15T15:20:55+00:00",
"updated_at": "2019-05-15T15:20:55+00:00"
} Key fields
| Field | Type | Example |
|---|---|---|
id | integer | 6805126730 |
state | string | success |
created_at | string | 2019-05-15T15:20:55+00:00 |
Full schema: 201 fields.
From GitHub docs
-
Content type
application/json
code
push
verified from a captured delivery
push Commits or tags pushed, or a branch or tag deleted
Identified by x-github-event header and action field in the body
Resource code
{
"ref": "refs/tags/demo",
"before": "0000000000000000000000000000000000000000",
"after": "b03b17320c22d5e46c5e302a150fdbe3abe39735",
"repository": { … },
"pusher": { … },
"sender": { … },
"created": true,
"deleted": false,
"forced": false
} Key fields
| Field | Type | Example |
|---|---|---|
created | boolean | true |
Full schema: 152 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
release
verified from a captured delivery
release Release created, published, edited or deleted
Identified by x-github-event header and action field in the body
Resource code
{
"action": "released",
"release": { … },
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
create
verified from a captured delivery
create Git branch or tag created
Identified by x-github-event header and action field in the body
Resource code
{
"ref": "demo",
"ref_type": "tag",
"master_branch": "main",
"description": null,
"pusher_type": "user",
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
delete
verified from a captured delivery
delete Git branch or tag deleted
Identified by x-github-event header and action field in the body
Resource code
{
"ref": "jane-doe-patch-1",
"ref_type": "branch",
"pusher_type": "user",
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
commit_comment
documented from GitHub docs (example)
commit_comment Someone comments on a commit
Identified by x-github-event header and action field in the body
Resource code
{
"action": "created",
"comment": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
fork
documented from GitHub docs (example)
fork A repository gets forked
Identified by x-github-event header and action field in the body
Resource code
{
"forkee": { … },
"repository": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
gollum
documented from GitHub docs (example)
gollum Wiki page created or updated
Identified by x-github-event header and action field in the body
Resource code
{
"pages": [ … ],
"repository": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
page_build
documented from GitHub docs (example)
page_build GitHub Pages build attempted, successful or not
Identified by x-github-event header and action field in the body
Resource code
{
"id": 130514899,
"build": { … },
"repository": { … },
"sender": { … },
"installation": { … }
} Key fields
| Field | Type | Example |
|---|---|---|
id | integer | 130514899 |
Full schema: 148 fields.
From GitHub docs
-
Content type
application/json
deployment
deployment
documented from GitHub docs (example)
deployment Deployment created for a repository
Identified by x-github-event header and action field in the body
Resource deployment
{
"deployment": { … },
"action": "created",
"workflow": { … },
"workflow_run": { … },
"repository": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
deploy_key
documented from GitHub docs (example)
deploy_key Deploy key added to or removed from a repository
Identified by x-github-event header and action field in the body
Resource deployment
{
"action": "created",
"key": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
deployment_protection_rule
documented No payload yet
deployment_protection_rule Protection rule requested for a deployment environment
Identified by x-github-event header and action field in the body
Resource deployment
No payload yet.
deployment_review
documented from GitHub docs (example)
deployment_review Deployment review requested, approved or rejected
Identified by x-github-event header and action field in the body
Resource deployment
{
"action": "requested",
"workflow_run": { … },
"since": "2023-07-04T09:28:15Z",
"workflow_job_run": { … },
"environment": "TST",
"reviewers": [ … ],
"requestor": { … },
"repository": { … }
} From GitHub docs
-
Content type
application/json
deployment_status
documented from GitHub docs (example)
deployment_status A deployment's status changes
Identified by x-github-event header and action field in the body
Resource deployment
{
"deployment_status": { … },
"deployment": { … },
"action": "created",
"check_run": { … },
"workflow_run": { … },
"repository": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
installation
github_app_authorization
documented from GitHub docs (example)
github_app_authorization User withdraws a GitHub App's authorization
Identified by x-github-event header and action field in the body
Resource installation
{
"action": "revoked",
"sender": { … }
} From GitHub docs
-
Content type
application/json
installation
documented from GitHub docs (example)
installation GitHub App installed, removed, suspended or unsuspended
Identified by x-github-event header and action field in the body
Resource installation
{
"action": "created",
"installation": { … },
"repositories": [ … ],
"sender": { … }
} From GitHub docs
-
Content type
application/json
installation_repositories
documented from GitHub docs (example)
installation_repositories Repositories added to or removed from an app installation
Identified by x-github-event header and action field in the body
Resource installation
{
"action": "added",
"installation": { … },
"repository_selection": "selected",
"repositories_added": [ … ],
"repositories_removed": [ … ],
"requester": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
installation_target
documented No payload yet
installation_target Account holding a GitHub App installation is renamed
Identified by x-github-event header and action field in the body
Resource installation
No payload yet.
marketplace_purchase
documented from GitHub docs (example)
marketplace_purchase GitHub Marketplace plan purchased, changed or cancelled
Identified by x-github-event header and action field in the body
Resource installation
{
"action": "changed",
"effective_date": "2017-10-25T00:00:00+00:00",
"sender": { … },
"marketplace_purchase": { … },
"previous_marketplace_purchase": { … }
} From GitHub docs
-
Content type
application/json
personal_access_token_request
documented No payload yet
personal_access_token_request Fine-grained token request created, approved, denied or cancelled
Identified by x-github-event header and action field in the body
Resource installation
No payload yet.
issues
issues
documented from GitHub docs (example)
issues Issue opened, edited, closed, labeled or otherwise changed
Identified by x-github-event header and action field in the body
Resource issues
{
"action": "edited",
"issue": { … },
"changes": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
issue_comment
verified from a captured delivery
issue_comment Comment on an issue or pull request created, edited or deleted
Identified by x-github-event header and action field in the body
Resource issues
{
"action": "created",
"issue": { … },
"comment": { … },
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
issue_dependencies
documented No payload yet
issue_dependencies Blocking or blocked-by link added to or removed from an issue
Identified by x-github-event header and action field in the body
Resource issues
No payload yet.
issue_relates_to
documented No payload yet
issue_relates_to Relates-to link between two issues added or removed
Identified by x-github-event header and action field in the body
Resource issues
No payload yet.
label
verified from a captured delivery
label Label created, edited, archived or deleted
Identified by x-github-event header and action field in the body
Resource issues
{
"action": "deleted",
"label": { … },
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
milestone
documented from GitHub docs (example)
milestone Milestone created, edited, opened, closed or deleted
Identified by x-github-event header and action field in the body
Resource issues
{
"action": "closed",
"milestone": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
sub_issues
documented No payload yet
sub_issues Sub-issue or parent issue link added or removed
Identified by x-github-event header and action field in the body
Resource issues
No payload yet.
organization
custom_property
documented No payload yet
custom_property Organization custom property created, updated or deleted
Identified by x-github-event header and action field in the body
Resource organization
No payload yet.
custom_property_values
documented No payload yet
custom_property_values Custom property values change on a repository
Identified by x-github-event header and action field in the body
Resource organization
No payload yet.
member
documented from GitHub docs (example)
member Repository collaborator added, removed or changed
Identified by x-github-event header and action field in the body
Resource organization
{
"action": "added",
"member": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
membership
documented from GitHub docs (example)
membership User added to or removed from a team
Identified by x-github-event header and action field in the body
Resource organization
{
"action": "added",
"scope": "team",
"member": { … },
"sender": { … },
"team": { … },
"organization": { … }
} From GitHub docs
-
Content type
application/json
org_block
documented from GitHub docs (example)
org_block Organization blocks or unblocks a non-member
Identified by x-github-event header and action field in the body
Resource organization
{
"action": "blocked",
"blocked_user": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
organization
documented from GitHub docs (example)
organization Organization deleted, renamed or its membership changes
Identified by x-github-event header and action field in the body
Resource organization
{
"action": "renamed",
"changes": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
sponsorship
documented from GitHub docs (example)
sponsorship Sponsorship created, cancelled, edited or changes tier
Identified by x-github-event header and action field in the body
Resource organization
{
"action": "created",
"sponsorship": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
team
documented from GitHub docs (example)
team Team created, edited, deleted or linked to a repository
Identified by x-github-event header and action field in the body
Resource organization
{
"changes": { … },
"action": "edited",
"team": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
team_add
documented from GitHub docs (example)
team_add Team added to a repository
Identified by x-github-event header and action field in the body
Resource organization
{
"team": { … },
"repository": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
project
project
documented from GitHub docs (example)
project Classic project created, edited, closed, reopened or deleted
Identified by x-github-event header and action field in the body
Resource project
{
"action": "created",
"project": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
project_card
documented from GitHub docs (example)
project_card Classic project card created, moved, converted, edited or deleted
Identified by x-github-event header and action field in the body
Resource project
{
"action": "moved",
"changes": { … },
"project_card": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
project_column
documented from GitHub docs (example)
project_column Classic project column created, moved, edited or deleted
Identified by x-github-event header and action field in the body
Resource project
{
"action": "edited",
"changes": { … },
"project_column": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
projects_v2
documented No payload yet
projects_v2 Organization-level project created, edited, closed, reopened or deleted
Identified by x-github-event header and action field in the body
Resource project
No payload yet.
projects_v2_item
documented from GitHub docs (example)
projects_v2_item Project item created, edited, reordered, archived or deleted
Identified by x-github-event header and action field in the body
Resource project
{
"action": "edited",
"projects_v2_item": { … },
"changes": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
projects_v2_status_update
documented No payload yet
projects_v2_status_update Project status update created, edited or deleted
Identified by x-github-event header and action field in the body
Resource project
No payload yet.
pull_request
pull_request
verified from a captured delivery
pull_request Pull request opened, closed, edited, labeled or otherwise changed
Identified by x-github-event header and action field in the body
Resource pull_request
{
"action": "labeled",
"number": 1,
"pull_request": { … },
"label": { … },
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
pull_request_review
documented from GitHub docs (example)
pull_request_review Pull request review submitted, edited or dismissed
Identified by x-github-event header and action field in the body
Resource pull_request
{
"action": "dismissed",
"review": { … },
"pull_request": { … },
"repository": { … },
"sender": { … },
"installation": { … },
"organization": { … }
} From GitHub docs
-
Content type
application/json
pull_request_review_comment
documented from GitHub docs (example)
pull_request_review_comment Comment on a pull request diff created, edited or deleted
Identified by x-github-event header and action field in the body
Resource pull_request
{
"action": "edited",
"changes": { … },
"comment": { … },
"pull_request": { … },
"repository": { … },
"installation": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
pull_request_review_thread
documented from GitHub docs (example)
pull_request_review_thread Pull request comment thread resolved or unresolved
Identified by x-github-event header and action field in the body
Resource pull_request
{
"action": "resolved",
"pull_request": { … },
"thread": { … },
"repository": { … },
"installation": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
repository
star
verified from a captured delivery
star Repository starred or unstarred
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "created",
"starred_at": "2023-03-06T04:19:17Z",
"repository": { … },
"sender": { … }
} Key fields
| Field | Type | Example |
|---|---|---|
starred_at | string | 2023-03-06T04:19:17Z |
Full schema: 119 fields.
Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
ping
verified from a captured delivery
ping Test event sent when a webhook is created
Identified by x-github-event header and action field in the body
Resource repository
{
"zen": "Speak like a human.",
"hook_id": 403738602,
"hook": { … },
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
branch_protection_configuration
documented No payload yet
branch_protection_configuration All branch protections enabled or disabled for a repository
Identified by x-github-event header and action field in the body
Resource repository
No payload yet.
branch_protection_rule
documented from GitHub docs (example)
branch_protection_rule Branch protection rule created, edited or deleted
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "edited",
"rule": { … },
"changes": { … },
"repository": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
discussion
documented from GitHub docs (example)
discussion Discussion created, edited, answered, closed or otherwise changed
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "edited",
"discussion": { … },
"changes": { … },
"repository": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
discussion_comment
documented from GitHub docs (example)
discussion_comment Comment on a discussion created, edited or deleted
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "edited",
"changes": { … },
"comment": { … },
"discussion": { … },
"repository": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
meta
documented from GitHub docs (example)
meta The webhook itself is deleted
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "deleted",
"hook_id": 101047067,
"hook": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
package
documented from GitHub docs (example)
package GitHub Packages package published or updated
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "published",
"package": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
public
documented from GitHub docs (example)
public Private repository made public
Identified by x-github-event header and action field in the body
Resource repository
{
"repository": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
registry_package
documented from GitHub docs (example)
registry_package Older package event: published or updated; prefer package
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "published",
"registry_package": { … },
"repository": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
repository
documented from GitHub docs (example)
repository Repository created, renamed, archived, transferred or deleted
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "edited",
"changes": { … },
"repository": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
repository_import
documented from GitHub docs (example)
repository_import Repository imported into GitHub, with its status
Identified by x-github-event header and action field in the body
Resource repository
{
"status": "success",
"repository": { … },
"organization": { … },
"sender": { … }
} Key fields
| Field | Type | Example |
|---|---|---|
status | string | success |
Full schema: 129 fields.
From GitHub docs
-
Content type
application/json
repository_ruleset
documented No payload yet
repository_ruleset Repository ruleset created, edited or deleted
Identified by x-github-event header and action field in the body
Resource repository
No payload yet.
watch
verified from a captured delivery
watch Someone starts watching a repository
Identified by x-github-event header and action field in the body
Resource repository
{
"action": "started",
"repository": { … },
"sender": { … }
} Seen in a captured delivery
-
Content type
application/json -
Headers
user-agent,content-type,x-github-delivery,x-github-event,x-github-hook-id,x-github-hook-installation-target-id,x-github-hook-installation-target-type
security
code_scanning_alert
documented from GitHub docs (example)
code_scanning_alert Code scanning alert created, fixed, closed or reopened
Identified by x-github-event header and action field in the body
Resource security
{
"action": "fixed",
"alert": { … },
"ref": "refs/pull/11/merge",
"commit_oid": "c5bf87afac650dbcb5fd97cfc22fcae5303da8e1",
"repository": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
dependabot_alert
documented from GitHub docs (example)
dependabot_alert Dependabot alert created, dismissed, fixed or reopened
Identified by x-github-event header and action field in the body
Resource security
{
"action": "fixed",
"alert": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
repository_advisory
documented No payload yet
repository_advisory Repository security advisory reported or published
Identified by x-github-event header and action field in the body
Resource security
No payload yet.
repository_vulnerability_alert
documented from GitHub docs (example)
repository_vulnerability_alert Older vulnerability alert event, closing down; use dependabot_alert
Identified by x-github-event header and action field in the body
Resource security
{
"action": "create",
"alert": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
secret_scanning_alert
documented from GitHub docs (example)
secret_scanning_alert Secret scanning alert created, resolved, reopened or validated
Identified by x-github-event header and action field in the body
Resource security
{
"action": "reopened",
"alert": { … },
"repository": { … },
"organization": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
secret_scanning_alert_location
documented from GitHub docs (example)
secret_scanning_alert_location New location found for a secret scanning alert
Identified by x-github-event header and action field in the body
Resource security
{
"action": "created",
"alert": { … },
"location": { … },
"repository": { … },
"sender": { … }
} From GitHub docs
-
Content type
application/json
secret_scanning_scan
documented No payload yet
secret_scanning_scan Secret scan of a repository completes
Identified by x-github-event header and action field in the body
Resource security
No payload yet.
security_advisory
documented from GitHub docs (example)
security_advisory GitHub-reviewed global advisory published, updated or withdrawn
Identified by x-github-event header and action field in the body
Resource security
{
"action": "updated",
"security_advisory": { … }
} From GitHub docs
-
Content type
application/json
security_and_analysis
documented No payload yet
security_and_analysis Security features turned on or off for a repository
Identified by x-github-event header and action field in the body
Resource security
No payload yet.
workflow
workflow_run
documented from GitHub docs (example)
workflow_run Actions workflow run requested, in progress or completed
Identified by x-github-event header and action field in the body
Resource workflow
{
"action": "completed",
"organization": { … },
"repository": { … },
"sender": { … },
"workflow": { … },
"workflow_run": { … }
} From GitHub docs
-
Content type
application/json
repository_dispatch
documented from GitHub docs (example)
repository_dispatch Custom event sent through the repository dispatches API
Identified by x-github-event header and action field in the body
Resource workflow
{
"action": "on-demand-test",
"branch": "master",
"client_payload": { … },
"repository": { … },
"organization": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
workflow_dispatch
documented from GitHub docs (example)
workflow_dispatch GitHub Actions workflow triggered by hand
Identified by x-github-event header and action field in the body
Resource workflow
{
"inputs": { … },
"ref": "refs/heads/master",
"repository": { … },
"organization": { … },
"sender": { … },
"workflow": ".github/workflows/hello-world-workflow.yml"
} From GitHub docs
-
Content type
application/json
workflow_job
documented from GitHub docs (example)
workflow_job Actions workflow job queued, waiting, running or finished
Identified by x-github-event header and action field in the body
Resource workflow
{
"action": "queued",
"workflow_job": { … },
"repository": { … },
"sender": { … },
"installation": { … }
} From GitHub docs
-
Content type
application/json
Route GitHub events by type.
Event Gateway receives every GitHub delivery and filters and routes it by event type, so each service gets only the events it handles.