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 created, completed or re-requested

Identified by x-github-event header and action field in the body Resource checks

github-check-run.json
{
  "action": "created",
  "check_run": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

check_suite

documented from GitHub docs (example)

Check suite requested, re-requested or completed

Identified by x-github-event header and action field in the body Resource checks

github-check-suite.json
{
  "action": "completed",
  "check_suite": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

merge_group

documented from GitHub docs (example)

Merge queue group requests checks or is destroyed

Identified by x-github-event header and action field in the body Resource checks

github-merge-group.json
{
  "action": "checks_requested",
  "merge_group": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

status

documented from GitHub docs (example)

A Git commit's status changes

Identified by x-github-event header and action field in the body Resource checks

github-status.json
{
  "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

Send example to Inspect → View as JSON

code

push

verified from a captured delivery

Commits or tags pushed, or a branch or tag deleted

Identified by x-github-event header and action field in the body Resource code

github-push.json
{
  "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

Send example to Inspect → View as JSON

release

verified from a captured delivery

Release created, published, edited or deleted

Identified by x-github-event header and action field in the body Resource code

github-release.json
{
  "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

Send example to Inspect → View as JSON

create

verified from a captured delivery

Git branch or tag created

Identified by x-github-event header and action field in the body Resource code

github-create.json
{
  "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

Send example to Inspect → View as JSON

delete

verified from a captured delivery

Git branch or tag deleted

Identified by x-github-event header and action field in the body Resource code

github-delete.json
{
  "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

Send example to Inspect → View as JSON

commit_comment

documented from GitHub docs (example)

Someone comments on a commit

Identified by x-github-event header and action field in the body Resource code

github-commit-comment.json
{
  "action": "created",
  "comment": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

fork

documented from GitHub docs (example)

A repository gets forked

Identified by x-github-event header and action field in the body Resource code

github-fork.json
{
  "forkee": { … },
  "repository": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

gollum

documented from GitHub docs (example)

Wiki page created or updated

Identified by x-github-event header and action field in the body Resource code

github-gollum.json
{
  "pages": [ … ],
  "repository": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

page_build

documented from GitHub docs (example)

GitHub Pages build attempted, successful or not

Identified by x-github-event header and action field in the body Resource code

github-page-build.json
{
  "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

Send example to Inspect → View as JSON

deployment

deployment

documented from GitHub docs (example)

Deployment created for a repository

Identified by x-github-event header and action field in the body Resource deployment

github-deployment.json
{
  "deployment": { … },
  "action": "created",
  "workflow": { … },
  "workflow_run": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

deploy_key

documented from GitHub docs (example)

Deploy key added to or removed from a repository

Identified by x-github-event header and action field in the body Resource deployment

github-deploy-key.json
{
  "action": "created",
  "key": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

deployment_protection_rule

documented No payload yet

Protection rule requested for a deployment environment

Identified by x-github-event header and action field in the body Resource deployment

No payload yet.

Help fill this in → View as JSON

deployment_review

documented from GitHub docs (example)

Deployment review requested, approved or rejected

Identified by x-github-event header and action field in the body Resource deployment

github-deployment-review.json
{
  "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

Send example to Inspect → View as JSON

deployment_status

documented from GitHub docs (example)

A deployment's status changes

Identified by x-github-event header and action field in the body Resource deployment

github-deployment-status.json
{
  "deployment_status": { … },
  "deployment": { … },
  "action": "created",
  "check_run": { … },
  "workflow_run": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

installation

github_app_authorization

documented from GitHub docs (example)

User withdraws a GitHub App's authorization

Identified by x-github-event header and action field in the body Resource installation

github-github-app-authorization.json
{
  "action": "revoked",
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

installation

documented from GitHub docs (example)

GitHub App installed, removed, suspended or unsuspended

Identified by x-github-event header and action field in the body Resource installation

github-installation.json
{
  "action": "created",
  "installation": { … },
  "repositories": [ … ],
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

installation_repositories

documented from GitHub docs (example)

Repositories added to or removed from an app installation

Identified by x-github-event header and action field in the body Resource installation

github-installation-repositories.json
{
  "action": "added",
  "installation": { … },
  "repository_selection": "selected",
  "repositories_added": [ … ],
  "repositories_removed": [ … ],
  "requester": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

installation_target

documented No payload yet

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.

Help fill this in → View as JSON

marketplace_purchase

documented from GitHub docs (example)

GitHub Marketplace plan purchased, changed or cancelled

Identified by x-github-event header and action field in the body Resource installation

github-marketplace-purchase.json
{
  "action": "changed",
  "effective_date": "2017-10-25T00:00:00+00:00",
  "sender": { … },
  "marketplace_purchase": { … },
  "previous_marketplace_purchase": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

personal_access_token_request

documented No payload yet

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.

Help fill this in → View as JSON

issues

issues

documented from GitHub docs (example)

Issue opened, edited, closed, labeled or otherwise changed

Identified by x-github-event header and action field in the body Resource issues

github-issues.json
{
  "action": "edited",
  "issue": { … },
  "changes": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

issue_comment

verified from a captured delivery

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

github-issue-comment.json
{
  "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

Send example to Inspect → View as JSON

issue_dependencies

documented No payload yet

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.

Help fill this in → View as JSON

issue_relates_to

documented No payload yet

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.

Help fill this in → View as JSON

label

verified from a captured delivery

Label created, edited, archived or deleted

Identified by x-github-event header and action field in the body Resource issues

github-label.json
{
  "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

Send example to Inspect → View as JSON

milestone

documented from GitHub docs (example)

Milestone created, edited, opened, closed or deleted

Identified by x-github-event header and action field in the body Resource issues

github-milestone.json
{
  "action": "closed",
  "milestone": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

sub_issues

documented No payload yet

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.

Help fill this in → View as JSON

organization

custom_property

documented No payload yet

Organization custom property created, updated or deleted

Identified by x-github-event header and action field in the body Resource organization

No payload yet.

Help fill this in → View as JSON

custom_property_values

documented No payload yet

Custom property values change on a repository

Identified by x-github-event header and action field in the body Resource organization

No payload yet.

Help fill this in → View as JSON

member

documented from GitHub docs (example)

Repository collaborator added, removed or changed

Identified by x-github-event header and action field in the body Resource organization

github-member.json
{
  "action": "added",
  "member": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

membership

documented from GitHub docs (example)

User added to or removed from a team

Identified by x-github-event header and action field in the body Resource organization

github-membership.json
{
  "action": "added",
  "scope": "team",
  "member": { … },
  "sender": { … },
  "team": { … },
  "organization": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

org_block

documented from GitHub docs (example)

Organization blocks or unblocks a non-member

Identified by x-github-event header and action field in the body Resource organization

github-org-block.json
{
  "action": "blocked",
  "blocked_user": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

organization

documented from GitHub docs (example)

Organization deleted, renamed or its membership changes

Identified by x-github-event header and action field in the body Resource organization

github-organization.json
{
  "action": "renamed",
  "changes": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

sponsorship

documented from GitHub docs (example)

Sponsorship created, cancelled, edited or changes tier

Identified by x-github-event header and action field in the body Resource organization

github-sponsorship.json
{
  "action": "created",
  "sponsorship": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

team

documented from GitHub docs (example)

Team created, edited, deleted or linked to a repository

Identified by x-github-event header and action field in the body Resource organization

github-team.json
{
  "changes": { … },
  "action": "edited",
  "team": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

team_add

documented from GitHub docs (example)

Team added to a repository

Identified by x-github-event header and action field in the body Resource organization

github-team-add.json
{
  "team": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

project

project

documented from GitHub docs (example)

Classic project created, edited, closed, reopened or deleted

Identified by x-github-event header and action field in the body Resource project

github-project.json
{
  "action": "created",
  "project": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

project_card

documented from GitHub docs (example)

Classic project card created, moved, converted, edited or deleted

Identified by x-github-event header and action field in the body Resource project

github-project-card.json
{
  "action": "moved",
  "changes": { … },
  "project_card": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

project_column

documented from GitHub docs (example)

Classic project column created, moved, edited or deleted

Identified by x-github-event header and action field in the body Resource project

github-project-column.json
{
  "action": "edited",
  "changes": { … },
  "project_column": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

projects_v2

documented No payload yet

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.

Help fill this in → View as JSON

projects_v2_item

documented from GitHub docs (example)

Project item created, edited, reordered, archived or deleted

Identified by x-github-event header and action field in the body Resource project

github-projects-v2-item.json
{
  "action": "edited",
  "projects_v2_item": { … },
  "changes": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

projects_v2_status_update

documented No payload yet

Project status update created, edited or deleted

Identified by x-github-event header and action field in the body Resource project

No payload yet.

Help fill this in → View as JSON

pull_request

pull_request

verified from a captured delivery

Pull request opened, closed, edited, labeled or otherwise changed

Identified by x-github-event header and action field in the body Resource pull_request

github-pull-request.json
{
  "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

Send example to Inspect → View as JSON

pull_request_review

documented from GitHub docs (example)

Pull request review submitted, edited or dismissed

Identified by x-github-event header and action field in the body Resource pull_request

github-pull-request-review.json
{
  "action": "dismissed",
  "review": { … },
  "pull_request": { … },
  "repository": { … },
  "sender": { … },
  "installation": { … },
  "organization": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

pull_request_review_comment

documented from GitHub docs (example)

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

github-pull-request-review-comment.json
{
  "action": "edited",
  "changes": { … },
  "comment": { … },
  "pull_request": { … },
  "repository": { … },
  "installation": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

pull_request_review_thread

documented from GitHub docs (example)

Pull request comment thread resolved or unresolved

Identified by x-github-event header and action field in the body Resource pull_request

github-pull-request-review-thread.json
{
  "action": "resolved",
  "pull_request": { … },
  "thread": { … },
  "repository": { … },
  "installation": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

repository

star

verified from a captured delivery

Repository starred or unstarred

Identified by x-github-event header and action field in the body Resource repository

github-star.json
{
  "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

Send example to Inspect → View as JSON

ping

verified from a captured delivery

Test event sent when a webhook is created

Identified by x-github-event header and action field in the body Resource repository

github-ping.json
{
  "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

Send example to Inspect → View as JSON

branch_protection_configuration

documented No payload yet

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.

Help fill this in → View as JSON

branch_protection_rule

documented from GitHub docs (example)

Branch protection rule created, edited or deleted

Identified by x-github-event header and action field in the body Resource repository

github-branch-protection-rule.json
{
  "action": "edited",
  "rule": { … },
  "changes": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

discussion

documented from GitHub docs (example)

Discussion created, edited, answered, closed or otherwise changed

Identified by x-github-event header and action field in the body Resource repository

github-discussion.json
{
  "action": "edited",
  "discussion": { … },
  "changes": { … },
  "repository": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

discussion_comment

documented from GitHub docs (example)

Comment on a discussion created, edited or deleted

Identified by x-github-event header and action field in the body Resource repository

github-discussion-comment.json
{
  "action": "edited",
  "changes": { … },
  "comment": { … },
  "discussion": { … },
  "repository": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

meta

documented from GitHub docs (example)

The webhook itself is deleted

Identified by x-github-event header and action field in the body Resource repository

github-meta.json
{
  "action": "deleted",
  "hook_id": 101047067,
  "hook": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

package

documented from GitHub docs (example)

GitHub Packages package published or updated

Identified by x-github-event header and action field in the body Resource repository

github-package.json
{
  "action": "published",
  "package": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

public

documented from GitHub docs (example)

Private repository made public

Identified by x-github-event header and action field in the body Resource repository

github-public.json
{
  "repository": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

registry_package

documented from GitHub docs (example)

Older package event: published or updated; prefer package

Identified by x-github-event header and action field in the body Resource repository

github-registry-package.json
{
  "action": "published",
  "registry_package": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

repository

documented from GitHub docs (example)

Repository created, renamed, archived, transferred or deleted

Identified by x-github-event header and action field in the body Resource repository

github-repository.json
{
  "action": "edited",
  "changes": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

repository_import

documented from GitHub docs (example)

Repository imported into GitHub, with its status

Identified by x-github-event header and action field in the body Resource repository

github-repository-import.json
{
  "status": "success",
  "repository": { … },
  "organization": { … },
  "sender": { … }
}

Key fields

Field Type Example
status string success

Full schema: 129 fields.

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

repository_ruleset

documented No payload yet

Repository ruleset created, edited or deleted

Identified by x-github-event header and action field in the body Resource repository

No payload yet.

Help fill this in → View as JSON

watch

verified from a captured delivery

Someone starts watching a repository

Identified by x-github-event header and action field in the body Resource repository

github-watch.json
{
  "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

Send example to Inspect → View as JSON

security

code_scanning_alert

documented from GitHub docs (example)

Code scanning alert created, fixed, closed or reopened

Identified by x-github-event header and action field in the body Resource security

github-code-scanning-alert.json
{
  "action": "fixed",
  "alert": { … },
  "ref": "refs/pull/11/merge",
  "commit_oid": "c5bf87afac650dbcb5fd97cfc22fcae5303da8e1",
  "repository": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

dependabot_alert

documented from GitHub docs (example)

Dependabot alert created, dismissed, fixed or reopened

Identified by x-github-event header and action field in the body Resource security

github-dependabot-alert.json
{
  "action": "fixed",
  "alert": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

repository_advisory

documented No payload yet

Repository security advisory reported or published

Identified by x-github-event header and action field in the body Resource security

No payload yet.

Help fill this in → View as JSON

repository_vulnerability_alert

documented from GitHub docs (example)

Older vulnerability alert event, closing down; use dependabot_alert

Identified by x-github-event header and action field in the body Resource security

github-repository-vulnerability-alert.json
{
  "action": "create",
  "alert": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

secret_scanning_alert

documented from GitHub docs (example)

Secret scanning alert created, resolved, reopened or validated

Identified by x-github-event header and action field in the body Resource security

github-secret-scanning-alert.json
{
  "action": "reopened",
  "alert": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

secret_scanning_alert_location

documented from GitHub docs (example)

New location found for a secret scanning alert

Identified by x-github-event header and action field in the body Resource security

github-secret-scanning-alert-location.json
{
  "action": "created",
  "alert": { … },
  "location": { … },
  "repository": { … },
  "sender": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

secret_scanning_scan

documented No payload yet

Secret scan of a repository completes

Identified by x-github-event header and action field in the body Resource security

No payload yet.

Help fill this in → View as JSON

security_advisory

documented from GitHub docs (example)

GitHub-reviewed global advisory published, updated or withdrawn

Identified by x-github-event header and action field in the body Resource security

github-security-advisory.json
{
  "action": "updated",
  "security_advisory": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

security_and_analysis

documented No payload yet

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.

Help fill this in → View as JSON

workflow

workflow_run

documented from GitHub docs (example)

Actions workflow run requested, in progress or completed

Identified by x-github-event header and action field in the body Resource workflow

github-workflow-run.json
{
  "action": "completed",
  "organization": { … },
  "repository": { … },
  "sender": { … },
  "workflow": { … },
  "workflow_run": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

repository_dispatch

documented from GitHub docs (example)

Custom event sent through the repository dispatches API

Identified by x-github-event header and action field in the body Resource workflow

github-repository-dispatch.json
{
  "action": "on-demand-test",
  "branch": "master",
  "client_payload": { … },
  "repository": { … },
  "organization": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

workflow_dispatch

documented from GitHub docs (example)

GitHub Actions workflow triggered by hand

Identified by x-github-event header and action field in the body Resource workflow

github-workflow-dispatch.json
{
  "inputs": { … },
  "ref": "refs/heads/master",
  "repository": { … },
  "organization": { … },
  "sender": { … },
  "workflow": ".github/workflows/hello-world-workflow.yml"
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as JSON

workflow_job

documented from GitHub docs (example)

Actions workflow job queued, waiting, running or finished

Identified by x-github-event header and action field in the body Resource workflow

github-workflow-job.json
{
  "action": "queued",
  "workflow_job": { … },
  "repository": { … },
  "sender": { … },
  "installation": { … }
}

From GitHub docs

  • Content type application/json

Send example to Inspect → View as 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.

Not affiliated with GitHub. Facts are compiled from public sources and linked inline.