The identity and technical contract details declared by the specification.
webhook-config-insecure-ssl
webhook-config-content-type
string
The media type used to serialize the payloads. Supported values include json and form. The default is form.
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-config-url
string
The URL to which the payloads will be delivered.
webhook-config
object
Configuration object of the webhook
4 properties
simple-user
object
A GitHub user.
21 properties
18 required
validation-error
object
Validation Error
3 properties
2 required
nullable-scoped-installation
objectnull
7 properties
5 required
app-permissions
object
The permissions granted to the user access token.
45 properties
authorization
object
The authorization for an OAuth app, GitHub App, or a Personal Access Token.
15 properties
13 required
nullable-simple-user
objectnull
A GitHub user.
21 properties
18 required
gist-comment
object
A comment made to a gist.
8 properties
8 required
gist-simple
object
Gist Simple
21 properties
basic-error
object
Basic Error
4 properties
author-association
string
How the author is associated with the repository.
public-user
object
Public User
39 properties
31 required
gist-history
object
Gist History
5 properties
team-organization
object
Team Organization
48 properties
23 required
validation-error-simple
object
Validation Error Simple
3 properties
2 required
organization-custom-repository-role-update-schema
object
4 properties
team-full
object
Groups of organization members that gives permissions on specified repositories.
18 properties
15 required
runner-groups-org
object
12 properties
7 required
external-group
object
Information about an external group's usage and its members
5 properties
4 required
team-discussion
object
A team discussion is a persistent record of a free-form conversation within a team.
18 properties
17 required
organization-full
object
Organization Full
56 properties
23 required
team-membership
object
Team Membership
3 properties
3 required
nullable-team-simple
objectnull
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
reaction-rollup
object
10 properties
10 required
org-pre-receive-hook
object
5 properties
empty-object
object
An object without any properties.
team-discussion-comment
object
A reply to a discussion within a team.
13 properties
12 required
organization-custom-repository-role
object
Custom repository roles created by organization owners
8 properties
7 required
org-hook
object
Org Hook
11 properties
10 required
project-card
object
Project cards represent a scope of work.
13 properties
9 required
project-column
object
Project columns contain cards of work.
8 properties
8 required
project
object
Projects are a way to organize columns and cards of work.
15 properties
13 required
empty-object_2
object
An object without any properties.
status-check-policy
object
Status Check Policy
5 properties
5 required
team
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
branch-restriction-policy
object
Branch Restriction Policy
7 properties
7 required
simple-user_2
object
GitHub user.
21 properties
18 required
protected-branch-pull-request-review
object
Protected Branch Pull Request Review
7 properties
2 required
validation-error_2
object
Validation Error
3 properties
2 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
nullable-team-simple_2
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
protected-branch
object
Branch protections protect branches
13 properties
1 required
nullable-simple-user_2
object
GitHub user.
21 properties
18 required
code-scanning-analysis-analysis-key
string
Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
code-scanning-ref
string
The Git reference, formatted as refs/pull/ /merge, refs/pull/ /head, refs/heads/ or simply .
code-scanning-alert-state
string
State of a code scanning alert.
alert-created-at
string
The time that the alert was created in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-alert-instance
object
10 properties
alert-html-url
string
The GitHub URL of the alert resource.
alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-default-setup-update
object
Configuration for code scanning default setup.
2 properties
1 required
code-scanning-alert
object
15 properties
12 required
code-scanning-alert-rule
object
9 properties
code-scanning-analysis-tool-guid
string
The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
code-scanning-analysis-tool-name
string
The name of the tool used to generate the code scanning analysis.
code-scanning-analysis-category
string
Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed o…
alert-instances-url
string
The REST API URL for fetching the list of instances for an alert.
code-scanning-alert-set-state
string
Sets the state of the code scanning alert. You must provide dismissedreason when you set the state to dismissed.
code-scanning-default-setup-update-response
object
You can use runurl to track the status of the run. This includes a property status and conclusion. You should not rely on this always being an actions workflow…
2 properties
alert-number
integer
The security alert number.
alert-fixed-at
string
The time that the alert was no longer detected and was considered fixed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
alert-dismissed-at
string
The time that the alert was dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
code-scanning-analysis-tool-version
string
The version of the tool used to generate the code scanning analysis.
code-scanning-alert-location
object
Describe a region within a file for the alert.
5 properties
empty-object_3
object
An object without any properties.
code-scanning-analysis-tool
object
3 properties
code-scanning-alert-dismissed-comment
string
The dismissal comment associated with the dismissal of the alert.
code-scanning-alert-dismissed-reason
string
Required when the state is dismissed. The reason for dismissing or closing the alert.
alert-url
string
The REST API URL of the alert resource.
code-scanning-alert-classification
string
classification of the file. For example to identify it as generated.
nullable-simple-user_3
object
GitHub user.
21 properties
18 required
code-scanning-alert-environment
string
Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language tha…
dependabot-alert-package
object
Details for the vulnerable package.
2 properties
2 required
scim-error
object
Scim Error
6 properties
alert-auto-dismissed-at
string
The time that the alert was auto-dismissed in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
dependabot-alert-security-vulnerability
object
Details pertaining to one vulnerable version range for the advisory.
4 properties
4 required
dependabot-alert-security-advisory
object
Details for the GitHub Security Advisory.
13 properties
13 required
dependabot-alert
object
Dependabot alert.
15 properties
14 required
empty-object_4
object
An object without any properties.
nullable-simple-user_4
object
GitHub user.
21 properties
18 required
repository-pre-receive-hook
object
4 properties
hook-response
object
3 properties
3 required
validation-error_3
object
Validation Error
3 properties
2 required
hook
object
Webhooks for repositories.
13 properties
12 required
simple-user_3
object
GitHub user.
21 properties
18 required
code-of-conduct
object
Code Of Conduct
5 properties
4 required
minimal-repository
object
Minimal Repository
87 properties
46 required
security-and-analysis
object
3 properties
nullable-simple-user_5
object
GitHub user.
21 properties
18 required
repository-invitation
object
Repository invitations let you manage who you collaborate with.
10 properties
9 required
issue-comment
object
Comments provide a way for people to collaborate on an issue.
14 properties
9 required
simple-user_4
object
GitHub user.
21 properties
18 required
nullable-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
repository
object
repository on GitHub.
95 properties
73 required
validation-error_4
object
Validation Error
3 properties
2 required
nullable-simple-user_6
object
GitHub user.
21 properties
18 required
issue
object
Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
34 properties
21 required
nullable-milestone
object
collection of related issues and pull requests.
16 properties
16 required
nullable-license-simple
object
License Simple
6 properties
5 required
link
object
Hypermedia Link
1 property
1 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
simple-user_5
object
GitHub user.
21 properties
18 required
validation-error_5
object
Validation Error
3 properties
2 required
team-simple
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
auto-merge
object
The status of auto merging a pull request.
4 properties
4 required
pull-request-review-comment
object
Pull Request Review Comments are comments on a portion of the Pull Request's diff.
29 properties
16 required
pull-request-review
object
Pull Request Reviews are reviews on pull requests.
13 properties
10 required
nullable-simple-user_7
object
GitHub user.
21 properties
18 required
nullable-milestone_2
object
collection of related issues and pull requests.
16 properties
16 required
wait-timer
integer
The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).
deployment-simple
object
deployment created as the result of an Actions check run from a workflow that references an environment
14 properties
10 required
deployment-branch-policy-name-pattern
object
1 property
1 required
pull-request-minimal
object
5 properties
5 required
release
object
release.
22 properties
17 required
check-run
object
check performed on the code of a given code change
17 properties
16 required
nullable-simple-user_8
object
GitHub user.
21 properties
18 required
secret-scanning-alert-resolution
string
Required when the state is resolved. The reason for resolving the alert.
secret-scanning-alert-state
string
Sets the state of the secret scanning alert. You must provide resolution when you set the state to resolved.
team_2
object
Groups of organization members that gives permissions on specified repositories.
13 properties
11 required
deployment-reviewer-type
string
The type of reviewer.
validation-error_6
object
Validation Error
3 properties
2 required
release-asset
object
Data related to a release.
13 properties
13 required
nullable-team-simple_3
object
Groups of organization members that gives permissions on specified repositories.
12 properties
10 required
empty-object_5
object
An object without any properties.
deployment-branch-policy
object
Details of a deployment branch policy.
3 properties
nullable-repository
object
repository on GitHub.
95 properties
73 required
minimal-repository_2
object
Minimal Repository
87 properties
46 required
secret-scanning-alert-resolution-comment
string
An optional comment when closing an alert. Cannot be updated or deleted. Must be null when changing state to open.
file-commit
object
File Commit
2 properties
2 required
label
object
Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
7 properties
7 required
milestone
object
collection of related issues and pull requests.
16 properties
16 required
nullable-alert-updated-at
string
The time that the alert was last updated in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
environment
object
Details of a deployment environment
9 properties
7 required
git-ref
object
Git references within a repository
4 properties
4 required
simple-user_6
object
GitHub user.
21 properties
18 required
nullable-integration_2
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
repository_2
object
repository on GitHub.
95 properties
73 required
commit-comment
object
Commit Comment
14 properties
13 required
code-of-conduct-simple
object
Code of Conduct Simple
4 properties
4 required
full-repository
object
Full Repository
102 properties
75 required
secret-scanning-alert
object
17 properties
check-suite-preference
object
Check suite configuration preferences for a repository.
2 properties
2 required
deployment-branch-policy-settings
object
The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.
2 properties
2 required
user-emails-response
array
The emails for the user.
user-role
array
The roles assigned to the user.
scim-error_2
object
Scim Error
6 properties
user-response
object
8 properties
3 required
scim-enterprise-user-response
scim-enterprise-group-response
user-name-response
object
4 properties
patch-schema
object
2 properties
2 required
group-response
object
4 properties
1 required
meta
object
The metadata associated with the creation/updates to the user.
4 properties
1 required
ldap-mapping-team
object
13 properties
The full machine-readable OpenAPI contract behind this narrative.
Other APIs GitHub publishes across the network.