The identity and technical contract details declared by the specification.
webhook-discussion-unanswered
object
6 properties
4 required
webhook-label-edited
object
8 properties
4 required
webhook-installation-created
object
8 properties
3 required
webhook-pull-request-review-submitted
object
8 properties
5 required
webhook-discussion-comment-deleted
object
8 properties
5 required
webhook-projects-v2-project-created
object
A project was created
5 properties
4 required
webhook-public
object
5 properties
2 required
alert-dismissed-at
stringnull
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-registry-package-updated
object
7 properties
3 required
webhook-check-run-created-form-encoded
object
The checkrun.created webhook encoded with URL encoding
1 property
1 required
webhook-deployment-review-requested
object
12 properties
10 required
webhook-code-scanning-alert-reopened
object
9 properties
6 required
webhook-pull-request-labeled
object
9 properties
5 required
webhook-pull-request-review-thread-unresolved
object
8 properties
4 required
webhook-team-edited
object
8 properties
5 required
webhook-check-run-completed
object
6 properties
3 required
webhook-installation-repositories-removed
object
10 properties
7 required
webhook-workflow-run-completed
object
8 properties
5 required
webhook-repository-vulnerability-alert-resolve
object
7 properties
4 required
webhook-rubygems-metadata
object
10 properties
webhook-project-card-deleted
object
7 properties
3 required
webhook-sponsorship-tier-changed
object
8 properties
4 required
webhook-security-advisory-updated
object
7 properties
2 required
webhook-discussion-edited
object
8 properties
4 required
webhook-discussion-created
object
7 properties
4 required
webhook-release-published
object
7 properties
3 required
secret-scanning-location-discussion-body
object
Represents a 'discussionbody' secret scanning location type. This location type shows that a secret was detected in the body of a discussion.
1 property
1 required
webhook-enterprise-anonymous-access-disabled
object
2 properties
1 required
webhook-project-reopened
object
7 properties
3 required
webhook-issues-milestoned
object
8 properties
5 required
dependabot-alert-security-vulnerability
object
Details pertaining to one vulnerable version range for the advisory.
4 properties
4 required
webhook-project-card-created
object
7 properties
3 required
projects-v2-item
object
An item belonging to a project
9 properties
6 required
webhook-discussion-comment-created
object
8 properties
5 required
webhook-pull-request-unassigned
object
9 properties
4 required
code-scanning-alert-dismissed-comment
stringnull
The dismissal comment associated with the dismissal of the alert.
discussion
object
A Discussion in a repository.
22 properties
20 required
webhook-code-scanning-alert-reopened-by-user
object
9 properties
6 required
nullable-license-simple
objectnull
License Simple
6 properties
5 required
webhook-branch-protection-rule-edited
object
8 properties
4 required
webhook-dependabot-alert-created
object
7 properties
4 required
enterprise-webhooks
object
An enterprise on GitHub. Webhook payloads contain the enterprise property when the webhook is configured on an enterprise account or an organization that's par…
10 properties
8 required
webhook-installation-repositories-added
object
10 properties
7 required
webhook-pull-request-review-requested
webhook-project-edited
object
8 properties
2 required
webhook-repository-created
object
6 properties
3 required
webhook-repository-transferred
object
7 properties
4 required
webhook-repository-deleted
object
6 properties
3 required
webhook-secret-scanning-alert-created
object
7 properties
3 required
webhook-create
object
10 properties
7 required
webhook-enterprise-anonymous-access-enabled
object
2 properties
1 required
webhook-milestone-edited
object
8 properties
5 required
webhook-meta-deleted
object
8 properties
3 required
webhook-code-scanning-alert-closed-by-user
object
9 properties
6 required
webhook-sponsorship-pending-tier-change
object
9 properties
4 required
webhook-pull-request-closed
object
8 properties
5 required
installation
object
Installation
20 properties
17 required
webhook-release-deleted
object
7 properties
4 required
webhook-issues-labeled
object
8 properties
4 required
webhook-repository-edited
object
7 properties
4 required
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
nullable-integration
objectnull
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
webhook-sponsorship-pending-cancellation
object
8 properties
3 required
webhook-workflow-job-completed
object
8 properties
4 required
secret-scanning-location-pull-request-title
object
Represents a 'pullrequesttitle' secret scanning location type. This location type shows that a secret was detected in the title of a pull request.
1 property
1 required
webhook-package-updated
object
7 properties
4 required
webhook-pull-request-converted-to-draft
object
8 properties
5 required
webhook-installation-unsuspend
object
8 properties
3 required
webhook-secret-scanning-alert-reopened
object
7 properties
3 required
webhook-package-published
object
7 properties
3 required
full-repository
object
Full Repository
102 properties
75 required
projects-v2
object
A projects v2 project
14 properties
14 required
enterprise
object
An enterprise on GitHub.
10 properties
8 required
webhook-pull-request-auto-merge-disabled
object
9 properties
6 required
webhook-team-deleted
object
7 properties
3 required
webhook-check-run-rerequested-form-encoded
object
The checkrun.rerequested webhook encoded with URL encoding
1 property
1 required
webhook-page-build
object
7 properties
4 required
webhook-discussion-deleted
object
7 properties
4 required
webhook-issue-comment-edited
object
9 properties
6 required
deployment-simple
object
A deployment created as the result of an Actions check run from a workflow that references an environment
14 properties
10 required
webhook-project-column-deleted
object
7 properties
2 required
organization-simple-webhooks
object
A GitHub organization. Webhook payloads contain the organization property when the webhook is configured for an organization, or when the event occurs from act…
12 properties
12 required
secret-scanning-location-discussion-comment
object
Represents a 'discussioncomment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion.
1 property
1 required
integration
object
GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They…
17 properties
11 required
webhook-workflow-job-queued
object
8 properties
4 required
webhook-discussion-pinned
object
7 properties
4 required
pull-request-minimal
object
5 properties
5 required
webhook-secret-scanning-alert-location-created
object
7 properties
4 required
secret-scanning-location-pull-request-review-comment
object
Represents a 'pullrequestreviewcomment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull reques…
1 property
1 required
webhook-projects-v2-project-edited
object
6 properties
5 required
webhook-check-run-requested-action-form-encoded
object
The checkrun.requestedaction webhook encoded with URL encoding
1 property
1 required
webhook-discussion-comment-edited
object
9 properties
6 required
webhook-deployment-status-created
object
11 properties
5 required
webhook-workflow-dispatch
object
8 properties
5 required
secret-scanning-alert-webhook
object
15 properties
webhook-check-suite-completed
object
7 properties
4 required
webhook-repository-vulnerability-alert-create
object
7 properties
4 required
webhook-discussion-locked
object
7 properties
4 required
webhook-config-url
string
The URL to which the payloads will be delivered.
webhook-project-column-edited
object
8 properties
3 required
webhook-organization-deleted
object
7 properties
3 required
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-pull-request-locked
object
8 properties
5 required
secret-scanning-location
object
2 properties
2 required
webhook-secret-scanning-alert-location-created-form-encoded
object
1 property
1 required
webhook-deploy-key-created
object
7 properties
4 required
webhook-workflow-run-in-progress
object
8 properties
5 required
webhook-organization-member-invited
object
8 properties
4 required
webhook-config-secret
string
If provided, the secret will be used as the key to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-serve…
webhook-check-run-rerequested
object
6 properties
3 required
webhook-membership-added
object
9 properties
6 required
secret-scanning-location-issue-title
object
Represents an 'issuetitle' secret scanning location type. This location type shows that a secret was detected in the title of an issue.
1 property
1 required
webhook-release-edited
object
8 properties
4 required
webhook-workflow-job-in-progress
object
8 properties
4 required
webhook-team-removed-from-repository
object
7 properties
4 required
webhook-sponsorship-created
object
7 properties
3 required
webhook-discussion-unlabeled
object
8 properties
5 required
webhook-installation-deleted
object
8 properties
3 required
webhook-discussion-answered
object
8 properties
5 required
webhook-pull-request-milestoned
object
8 properties
4 required
webhook-discussion-closed
object
7 properties
4 required
webhook-dependabot-alert-reintroduced
object
7 properties
4 required
webhook-project-card-moved
object
8 properties
3 required
webhook-branch-protection-rule-deleted
object
7 properties
4 required
link
object
Hypermedia Link
1 property
1 required
webhook-security-advisory-withdrawn
object
7 properties
2 required
webhook-fork
object
A user forks a repository.
6 properties
3 required
nullable-alert-updated-at
stringnull
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-team-created
object
7 properties
4 required
webhook-repository-privatized
object
6 properties
3 required
webhook-issues-unassigned
object
8 properties
4 required
webhook-pull-request-opened
object
8 properties
5 required
nullable-milestone
objectnull
A collection of related issues and pull requests.
16 properties
16 required
webhook-deploy-key-deleted
object
7 properties
4 required
webhook-check-run-completed-form-encoded
object
The checkrun.completed webhook encoded with URL encoding
1 property
1 required
webhook-issues-demilestoned
object
8 properties
4 required
alert-html-url
string
The GitHub URL of the alert resource.
webhook-release-created
object
7 properties
4 required
simple-check-suite
object
A suite of checks performed on the code of a given code change
14 properties
webhook-commit-comment-created
object
7 properties
4 required
pull-request
object
Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of…
48 properties
42 required
webhook-milestone-created
object
7 properties
4 required
webhook-watch-started
object
6 properties
3 required
alert-number
integer
The security alert number.
webhook-pull-request-review-comment-deleted
object
8 properties
5 required
webhook-projects-v2-project-reopened
object
5 properties
4 required
webhook-organization-member-added
object
7 properties
4 required
webhook-deployment-review-rejected
object
13 properties
6 required
webhook-issues-assigned
object
8 properties
4 required
webhook-installation-new-permissions-accepted
object
8 properties
3 required
secret-scanning-location-pull-request-review
object
Represents a 'pullrequestreview' secret scanning location type. This location type shows that a secret was detected in a review on a pull request.
1 property
1 required
webhook-discussion-unpinned
object
7 properties
4 required
webhook-deployment-created
object
9 properties
6 required
webhook-discussion-transferred
object
8 properties
5 required
webhook-milestone-deleted
object
7 properties
4 required
secret-scanning-location-pull-request-comment
object
Represents a 'pullrequestcomment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request.
1 property
1 required
webhook-deployment-review-approved
object
13 properties
6 required
webhook-dependabot-alert-reopened
object
7 properties
4 required
webhook-projects-v2-item-deleted
object
5 properties
4 required
webhook-cache-sync
object
9 properties
4 required
dependabot-alert-package
object
Details for the vulnerable package.
2 properties
2 required
webhook-projects-v2-item-archived
object
6 properties
5 required
webhook-installation-suspend
object
8 properties
3 required
webhook-sponsorship-cancelled
object
7 properties
3 required
webhook-github-app-authorization-revoked
object
2 properties
2 required
webhook-discussion-labeled
object
8 properties
5 required
webhook-installation-target-renamed
object
9 properties
5 required
webhook-issues-transferred
object
8 properties
5 required
webhook-member-removed
object
7 properties
4 required
webhook-repository-renamed
object
7 properties
4 required
webhook-ping-form-encoded
object
The webhooks ping payload encoded with URL encoding.
1 property
1 required
webhook-code-scanning-alert-fixed
object
9 properties
6 required
webhook-issues-unlabeled
object
8 properties
4 required
webhook-pull-request-reopened
object
8 properties
5 required
webhook-pull-request-review-comment-created
object
8 properties
5 required
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
webhook-team-add
object
6 properties
3 required
webhook-issues-pinned
object
7 properties
4 required
webhook-milestone-opened
object
7 properties
4 required
webhook-label-deleted
object
7 properties
4 required
check-run-with-simple-check-suite
object
A check performed on the code of a given code change
17 properties
16 required
webhook-star-deleted
object
7 properties
4 required
webhook-member-added
object
8 properties
4 required
webhook-pull-request-review-comment-edited
object
9 properties
6 required
hook-response
object
3 properties
3 required
secret-scanning-location-pull-request-body
object
Represents a 'pullrequestbody' secret scanning location type. This location type shows that a secret was detected in the body of a pull request.
1 property
1 required
webhook-projects-v2-item-created
object
5 properties
4 required
webhook-pull-request-review-request-removed
simple-installation
object
The GitHub App installation. Webhook payloads contain the installation property when the event is configured for and sent to a GitHub App. For more information…
2 properties
2 required
webhook-pull-request-review-thread-resolved
object
8 properties
4 required
webhook-ping
object
6 properties
nullable-repository-webhooks
objectnull
The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.
99 properties
73 required
webhook-pull-request-review-dismissed
object
8 properties
5 required
webhook-projects-v2-project-deleted
object
5 properties
4 required
webhook-discussion-reopened
object
7 properties
4 required
webhook-project-closed
object
7 properties
3 required
webhook-team-added-to-repository
object
7 properties
3 required
minimal-repository
object
Minimal Repository
87 properties
46 required
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-pull-request-unlabeled
object
9 properties
5 required
webhook-status
object
17 properties
13 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
milestone
object
A collection of related issues and pull requests.
16 properties
16 required
webhook-pull-request-demilestoned
object
8 properties
4 required
webhook-secret-scanning-alert-revoked
object
7 properties
3 required
deployment
object
A request for a specific ref(branch,sha,tag) to be deployed
18 properties
14 required
webhook-repository-vulnerability-alert-dismiss
object
7 properties
4 required
webhook-project-card-converted
object
8 properties
4 required
simple-user
object
A GitHub user.
21 properties
18 required
webhook-security-advisory-published
object
7 properties
2 required
webhook-organization-renamed
object
8 properties
3 required
secret-scanning-location-issue-comment
object
Represents an 'issuecomment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue.
1 property
1 required
alert-fixed-at
stringnull
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-check-run-created
object
6 properties
3 required
code-of-conduct-simple
object
Code of Conduct Simple
4 properties
4 required
webhook-repository-anonymous-access-enabled
object
6 properties
1 required
auto-merge
objectnull
The status of auto merging a pull request.
4 properties
4 required
webhook-dependabot-alert-dismissed
object
7 properties
4 required
webhook-member-edited
object
8 properties
5 required
webhook-user-deleted
object
7 properties
1 required
webhook-pull-request-ready-for-review
object
8 properties
5 required
webhook-issues-closed
object
7 properties
4 required
webhook-branch-protection-rule-created
object
7 properties
4 required
webhook-pull-request-edited
object
9 properties
5 required
webhook-project-column-moved
object
7 properties
3 required
webhook-issues-locked
object
7 properties
4 required
webhook-projects-v2-item-restored
object
6 properties
5 required
webhook-release-prereleased
object
7 properties
3 required
webhook-check-run-requested-action
object
7 properties
4 required
webhook-repository-anonymous-access-disabled
object
6 properties
1 required
dependabot-alert-security-advisory
object
Details for the GitHub Security Advisory.
13 properties
13 required
webhook-project-created
object
7 properties
3 required
webhook-issues-reopened
object
7 properties
4 required
webhook-gollum
object
6 properties
3 required
webhook-release-unpublished
object
7 properties
3 required
webhook-pull-request-review-edited
object
9 properties
6 required
webhook-sponsorship-edited
object
8 properties
4 required
webhook-repository-dispatch-sample
object
8 properties
6 required
secret-scanning-location-issue-body
object
Represents an 'issuebody' secret scanning location type. This location type shows that a secret was detected in the body of an issue.
1 property
1 required
webhook-repository-archived
object
6 properties
3 required
webhook-discussion-unlocked
object
7 properties
4 required
webhook-code-scanning-alert-appeared-in-branch
object
9 properties
6 required
webhook-milestone-closed
object
7 properties
4 required
webhook-check-suite-rerequested
object
7 properties
4 required
secret-scanning-location-commit
object
Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository.
9 properties
9 required
webhook-project-deleted
object
7 properties
2 required
webhook-membership-removed
object
9 properties
6 required
webhook-issue-comment-created
object
8 properties
5 required
webhook-workflow-run-requested
object
8 properties
5 required
webhook-security-and-analysis
object
6 properties
2 required
alert-url
string
The REST API URL of the alert resource.
webhook-registry-package-published
object
7 properties
3 required
webhook-pull-request-auto-merge-enabled
object
9 properties
5 required
webhook-issue-comment-deleted
object
8 properties
5 required
webhook-delete
object
8 properties
5 required
repository-webhooks
object
The repository on GitHub where the event occurred. Webhook payloads contain the repository property when the event occurs from activity in a repository.
99 properties
73 required
simple-user-webhooks
object
The GitHub user that triggered the event. This property is included in every webhook payload.
21 properties
18 required
nullable-repository
objectnull
A repository on GitHub.
95 properties
73 required
webhook-workflow-job-waiting
object
8 properties
4 required
security-and-analysis
objectnull
3 properties
webhook-code-scanning-alert-created
object
9 properties
6 required
webhook-organization-member-removed
object
7 properties
4 required
webhook-project-card-edited
object
8 properties
4 required
webhook-repository-vulnerability-alert-reopen
object
7 properties
4 required
webhook-config-insecure-ssl
webhook-projects-v2-item-edited
object
6 properties
4 required
webhook-projects-v2-item-converted
object
6 properties
5 required
projects-v2-item-content-type
string
The type of content tracked in a project item
secret-scanning-location-discussion-title
object
Represents a 'discussiontitle' secret scanning location type. This location type shows that a secret was detected in the title of a discussion.
1 property
1 required
webhook-issues-opened
object
8 properties
4 required
webhook-push
object
16 properties
12 required
webhook-issues-deleted
object
7 properties
4 required
dependabot-alert
object
A Dependabot alert.
15 properties
14 required
webhook-repository-publicized
object
6 properties
3 required
webhook-release-released
object
7 properties
3 required
webhook-label-created
object
7 properties
3 required
webhook-secret-scanning-alert-resolved
object
7 properties
3 required
webhook-user-created
object
7 properties
1 required
author-association
string
How the author is associated with the repository.
webhook-pull-request-synchronize
object
10 properties
7 required
webhook-issues-edited
object
9 properties
5 required
webhook-repository-unarchived
object
6 properties
3 required
webhook-dependabot-alert-fixed
object
7 properties
4 required
webhook-star-created
object
7 properties
4 required
webhook-issues-unpinned
object
7 properties
4 required
repository
object
A repository on GitHub.
95 properties
73 required
webhook-check-suite-requested
object
7 properties
4 required
alert-auto-dismissed-at
stringnull
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
webhook-pull-request-assigned
object
9 properties
6 required
secret-scanning-alert-resolution-webhook
stringnull
The reason for resolving the alert.
webhook-pull-request-unlocked
object
8 properties
5 required
webhook-issues-unlocked
object
7 properties
4 required
webhook-project-column-created
object
7 properties
2 required
webhook-projects-v2-item-reordered
object
6 properties
5 required
webhook-discussion-category-changed
object
8 properties
5 required
app-permissions
object
The permissions granted to the user access token.
45 properties
webhook-projects-v2-project-closed
object
5 properties
4 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.