openapi: 3.0.3
info:
version: 1.1.4
title: GitHub Application About Update API
description: 'Use the REST API to retrieve information about GitHub Apps and GitHub App
installations.'
license:
name: MIT
url: https://spdx.org/licenses/MIT
termsOfService: https://docs.github.com/articles/github-terms-of-service
contact:
name: Support
url: https://support.github.com/contact?tags=dotcom-rest-api
x-github-plan: ghes
x-github-release: 3.9
servers:
- url: '{protocol}://{hostname}/api/v3'
variables:
hostname:
description: Self-hosted Enterprise Server hostname
default: HOSTNAME
protocol:
description: Self-hosted Enterprise Server protocol
default: http
tags:
- name: Update
paths:
/app/hook/config:
patch:
summary: GitHub Updatewebhook Configuration for an App
description: 'Updates the webhook configuration for a GitHub App. For more information about configuring a webhook for your app, see "[Creating a GitHub App](/developers/apps/creating-a-github-app)."
You must use a [JWT](https://docs.github.com/enterprise-server@3.9/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.'
tags:
- Update
operationId: updatewebhookConfigurationForAnApp
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/apps/webhooks#update-a-webhook-configuration-for-an-app
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
url:
$ref: '#/components/schemas/webhook-config-url'
content_type:
$ref: '#/components/schemas/webhook-config-content-type'
secret:
$ref: '#/components/schemas/webhook-config-secret'
insecure_ssl:
$ref: '#/components/schemas/webhook-config-insecure-ssl'
examples:
default:
value:
content_type: json
insecure_ssl: '0'
secret: '********'
url: https://example.com/webhook
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-config'
examples:
default:
$ref: '#/components/examples/webhook-config'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: apps
subcategory: webhooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/authorizations/{authorization_id}:
patch:
summary: GitHub Update an Existing Authorization
description: '**Deprecation Notice:** GitHub Enterprise Server will discontinue the [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations/), which is used by integrations to create personal access tokens and OAuth tokens, and you must now create these tokens using our [web application flow](https://docs.github.com/enterprise-server@3.9/developers/apps/authorizing-oauth-apps#web-application-flow). The [OAuth Authorizations API](https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations) will be removed on November, 13, 2020. For more information, including scheduled brownouts, see the [blog post](https://developer.github.com/changes/2020-02-14-deprecating-oauth-auth-endpoint/).
If you have two-factor authentication setup, Basic Authentication for this endpoint requires that you use a one-time password (OTP) and your username and password instead of tokens. For more information, see "[Working with two-factor authentication](https://docs.github.com/enterprise-server@3.9/rest/overview/other-authentication-methods#working-with-two-factor-authentication)."
You can only send one of these scope keys at a time.'
tags:
- Update
operationId: updateAnExistingAuthorization
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/oauth-authorizations/oauth-authorizations#update-an-existing-authorization
parameters:
- $ref: '#/components/parameters/authorization-id'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
scopes:
description: A list of scopes that this authorization is in.
type: array
items:
type: string
example:
- public_repo
- user
nullable: true
add_scopes:
description: A list of scopes to add to this authorization.
type: array
items:
type: string
remove_scopes:
description: A list of scopes to remove from this authorization.
type: array
items:
type: string
note:
description: A note to remind you what the OAuth token is for.
type: string
example: Update all gems
note_url:
description: A URL to remind you what app the OAuth token is for.
type: string
fingerprint:
description: A unique string to distinguish an authorization from others created for the same client ID and user.
type: string
examples:
default:
summary: Example of updating scopes and note
value:
add_scopes:
- public_repo
remove_scopes:
- user
note: optional note
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/authorization'
examples:
default:
$ref: '#/components/examples/authorization-2'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
removalDate: '2020-11-13'
deprecationDate: '2020-02-14'
category: oauth-authorizations
subcategory: oauth-authorizations
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/gists/{gist_id}:
patch:
summary: GitHub Updategist
description: 'Allows you to update a gist''s description and to update, delete, or rename gist files. Files
from the previous version of the gist that aren''t explicitly changed during an edit
are unchanged.
At least one of `description` or `files` is required.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.'
tags:
- Update
operationId: updategist
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/gists/gists#update-a-gist
parameters:
- $ref: '#/components/parameters/gist-id'
requestBody:
required: true
content:
application/json:
schema:
properties:
description:
description: The description of the gist.
example: Example Ruby script
type: string
files:
description: 'The gist files to be updated, renamed, or deleted. Each `key` must match the current filename
(including extension) of the targeted gist file. For example: `hello.py`.
To delete a file, set the whole file to null. For example: `hello.py : null`. The file will also be
deleted if the specified object does not contain at least one of `content` or `filename`.'
example:
hello.rb:
content: blah
filename: goodbye.rb
type: object
additionalProperties:
type: object
nullable: true
properties:
content:
description: The new content of the file.
type: string
filename:
description: The new filename for the file.
type: string
nullable: true
type: object
nullable: true
examples:
updateGist:
summary: Updating a gist
value:
description: An updated gist description
files:
README.md:
content: Hello World from GitHub
deleteFile:
summary: Deleting a gist file
value:
files:
hello.py: null
renameFile:
summary: Renaming a gist file
value:
files:
hello.py:
filename: goodbye.py
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/gist-simple'
examples:
updateGist:
$ref: '#/components/examples/gist'
deleteFile:
$ref: '#/components/examples/delete-gist-file'
renameFile:
$ref: '#/components/examples/rename-gist-file'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: gists
subcategory: gists
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/gists/{gist_id}/comments/{comment_id}:
patch:
summary: GitHub Updategist Comment
description: 'Updates a comment on a gist.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown. This is the default if you do not pass any specific media type.
- **`application/vnd.github.base64+json`**: Returns the base64-encoded contents. This can be useful if your gist contains any invalid UTF-8 sequences.'
tags:
- Update
operationId: updategistComment
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/gists/comments#update-a-gist-comment
parameters:
- $ref: '#/components/parameters/gist-id'
- $ref: '#/components/parameters/comment-id'
requestBody:
required: true
content:
application/json:
schema:
properties:
body:
description: The comment text.
type: string
maxLength: 65535
example: Body of the attachment
type: object
required:
- body
examples:
default:
summary: Updating a comment in a gist
value:
body: This is an update to a comment in a gist
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/gist-comment'
examples:
default:
$ref: '#/components/examples/gist-comment'
'404':
$ref: '#/components/responses/not_found'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: gists
subcategory: comments
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/issues/comments/{comment_id}:
patch:
summary: GitHub Update an Issue Comment
description: 'You can use the REST API to update comments on issues and pull requests. Every pull request is an issue, but not every issue is a pull request.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.'
tags:
- Update
operationId: updateAnIssueComment
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/comments#update-an-issue-comment
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/comment-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
body:
type: string
description: The contents of the comment.
required:
- body
examples:
default:
value:
body: Me too
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/issue-comment'
examples:
default:
$ref: '#/components/examples/issue-comment'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: comments
x-api-evangelist-certified: '2025-07-18'
x-api-naftiko-published: '2025-07-18'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/issues/{issue_number}:
patch:
summary: GitHub Update an Issue
description: 'Issue owners and users with push access can edit an issue.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.'
tags:
- Update
operationId: updateAnIssue
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#update-an-issue
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/issue-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
oneOf:
- type: string
- type: integer
description: The title of the issue.
nullable: true
body:
type: string
description: The contents of the issue.
nullable: true
assignee:
type: string
nullable: true
description: Username to assign to this issue. **This field is deprecated.**
state:
type: string
description: The open or closed state of the issue.
enum:
- open
- closed
state_reason:
type: string
enum:
- completed
- not_planned
- reopened
nullable: true
description: The reason for the state change. Ignored unless `state` is changed.
example: not_planned
milestone:
oneOf:
- type: string
- type: integer
description: The `number` of the milestone to associate this issue with or use `null` to remove the current milestone. Only users with push access can set the milestone for issues. Without push access to the repository, milestone changes are silently dropped.
nullable: true
labels:
type: array
description: Labels to associate with this issue. Pass one or more labels to _replace_ the set of labels on this issue. Send an empty array (`[]`) to clear all labels from the issue. Only users with push access can set labels for issues. Without push access to the repository, label changes are silently dropped.
items:
oneOf:
- type: string
- type: object
properties:
id:
type: integer
name:
type: string
description:
type: string
nullable: true
color:
type: string
nullable: true
assignees:
type: array
description: Usernames to assign to this issue. Pass one or more user logins to _replace_ the set of assignees on this issue. Send an empty array (`[]`) to clear all assignees from the issue. Only users with push access can set assignees for new issues. Without push access to the repository, assignee changes are silently dropped.
items:
type: string
examples:
default:
value:
title: Found a bug
body: I'm having a problem with this.
assignees:
- octocat
milestone: 1
state: open
labels:
- bug
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/issue'
examples:
default:
$ref: '#/components/examples/issue'
'301':
$ref: '#/components/responses/moved_permanently'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'410':
$ref: '#/components/responses/gone'
'422':
$ref: '#/components/responses/validation_failed'
'503':
$ref: '#/components/responses/service_unavailable'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: issues
x-api-evangelist-certified: '2025-07-18'
x-api-naftiko-published: '2025-07-18'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}:
patch:
summary: GitHub Update an Organization
description: '**Parameter Deprecation Notice:** GitHub Enterprise Server will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).
Updates the organization''s profile and member privileges.
The authenticated user must be an organization owner to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `admin:org` or `repo` scope to use this endpoint.'
tags:
- Update
operationId: updateAnOrganization
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#update-an-organization
parameters:
- $ref: '#/components/parameters/org'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
billing_email:
type: string
description: Billing email address. This address is not publicized.
company:
type: string
description: The company name.
email:
type: string
description: The publicly visible email address.
twitter_username:
type: string
description: The Twitter username of the company.
location:
type: string
description: The location.
name:
type: string
description: The shorthand name of the company.
description:
type: string
description: The description of the company.
has_organization_projects:
type: boolean
description: Whether an organization can use organization projects.
has_repository_projects:
type: boolean
description: Whether repositories that belong to the organization can use repository projects.
default_repository_permission:
type: string
description: Default permission level members have for organization repositories.
enum:
- read
- write
- admin
- none
default: read
members_can_create_repositories:
type: boolean
description: Whether of non-admin organization members can create repositories. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.
default: true
members_can_create_internal_repositories:
type: boolean
description: Whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.
members_can_create_private_repositories:
type: boolean
description: Whether organization members can create private repositories, which are visible to organization members with permission. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.
members_can_create_public_repositories:
type: boolean
description: Whether organization members can create public repositories, which are visible to anyone. For more information, see "[Restricting repository creation in your organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)" in the GitHub Help documentation.
members_allowed_repository_creation_type:
type: string
description: "Specifies which types of repositories non-admin organization members can create. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details."
enum:
- all
- private
- none
members_can_create_pages:
type: boolean
description: Whether organization members can create GitHub Pages sites. Existing published sites will not be impacted.
default: true
members_can_fork_private_repositories:
type: boolean
description: Whether organization members can fork private organization repositories.
default: false
web_commit_signoff_required:
type: boolean
description: Whether contributors to organization repositories are required to sign off on commits they make through GitHub's web interface.
default: false
blog:
type: string
example: '"http://github.blog"'
advanced_security_enabled_for_new_repositories:
type: boolean
description: 'Whether GitHub Advanced Security is automatically enabled for new repositories.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
dependabot_alerts_enabled_for_new_repositories:
type: boolean
description: 'Whether Dependabot alerts is automatically enabled for new repositories.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
dependabot_security_updates_enabled_for_new_repositories:
type: boolean
description: 'Whether Dependabot security updates is automatically enabled for new repositories.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
dependency_graph_enabled_for_new_repositories:
type: boolean
description: 'Whether dependency graph is automatically enabled for new repositories.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
secret_scanning_enabled_for_new_repositories:
type: boolean
description: 'Whether secret scanning is automatically enabled for new repositories.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
secret_scanning_push_protection_enabled_for_new_repositories:
type: boolean
description: 'Whether secret scanning push protection is automatically enabled for new repositories.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
You can check which security and analysis features are currently enabled by using a `GET /orgs/{org}` request.'
secret_scanning_push_protection_custom_link_enabled:
type: boolean
description: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
secret_scanning_push_protection_custom_link:
type: string
description: If `secret_scanning_push_protection_custom_link_enabled` is true, the URL that will be displayed to contributors who are blocked from pushing a secret.
examples:
default:
value:
billing_email: mona@github.com
company: GitHub
email: mona@github.com
twitter_username: github
location: San Francisco
name: github
description: GitHub, the company.
default_repository_permission: read
members_can_create_repositories: true
members_allowed_repository_creation_type: all
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/organization-full'
examples:
default:
$ref: '#/components/examples/organization-full'
'409':
$ref: '#/components/responses/conflict'
'422':
description: Validation failed
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/validation-error'
- $ref: '#/components/schemas/validation-error-simple'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: orgs
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/actions/runner-groups/{runner_group_id}:
patch:
summary: GitHub Update Self-hosted Runner Group for an Organization
description: 'Updates the `name` and `visibility` of a self-hosted runner group in an organization.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
operationId: updateSelfhostedRunnerGroupForAnOrganization
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/self-hosted-runner-groups#update-a-self-hosted-runner-group-for-an-organization
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/runner-group-id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
description: Name of the runner group.
type: string
visibility:
description: Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories.
type: string
enum:
- selected
- all
- private
allows_public_repositories:
description: Whether the runner group can be used by `public` repositories.
type: boolean
default: false
restricted_to_workflows:
description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
type: boolean
default: false
selected_workflows:
description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
type: array
items:
type: string
description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
example: octo-org/octo-repo/.github/workflows/deploy.yaml@main
required:
- name
examples:
default:
value:
name: Expensive hardware runners
visibility: selected
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/runner-groups-org'
examples:
default:
$ref: '#/components/examples/runner-group'
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
category: actions
subcategory: self-hosted-runner-groups
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/actions/secrets/{secret_name}:
put:
summary: GitHub Create or Update an Organization Secret
description: 'Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)."
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
OAuth tokens and personal access tokens (classic) need the`admin:org` scope to use this endpoint. If the repository is private, OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: createOrUpdateAnOrganizationSecret
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-organization-secret
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/secret-name'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
encrypted_value:
type: string
description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-organization-public-key) endpoint.
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
key_id:
type: string
description: ID of the key you used to encrypt the secret.
visibility:
type: string
description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
enum:
- all
- private
- selected
selected_repository_ids:
type: array
description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#remove-selected-repository-from-an-organization-secret) endpoints.
items:
type: integer
required:
- visibility
examples:
default:
value:
encrypted_value: c2VjcmV0
key_id: 012345678912345678
visibility: selected
selected_repository_ids:
- 1296269
- 1296280
responses:
'201':
description: Response when creating a secret
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object'
examples:
default:
value: null
'204':
description: Response when updating a secret
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: secrets
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/actions/variables/{name}:
patch:
summary: GitHub Update an Organization Variable
description: 'Updates an organization variable that you can reference in a GitHub Actions workflow.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint. If the repository is private, the `repo` scope is also required.'
tags:
- Update
operationId: updateAnOrganizationVariable
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-organization-variable
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/variable-name'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the variable.
value:
type: string
description: The value of the variable.
visibility:
type: string
description: The type of repositories in the organization that can access the variable. `selected` means only the repositories specified by `selected_repository_ids` can access the variable.
enum:
- all
- private
- selected
selected_repository_ids:
type: array
description: An array of repository ids that can access the organization variable. You can only provide a list of repository ids when the `visibility` is set to `selected`.
items:
type: integer
examples:
default:
value:
name: USERNAME
value: octocat
visibility: selected
selected_repository_ids:
- 1296269
- 1296280
responses:
'204':
description: Response
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: variables
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/custom-repository-roles/{role_id}:
patch:
summary: GitHub Update Custom Repository Role
description: 'Updates a custom repository role that can be used by all repositories owned by the organization. For more information about custom repository roles, see "[About custom repository roles](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/about-custom-repository-roles)."
The authenticated user must be an administrator for the organization to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
tags:
- Update
operationId: updateCustomRepositoryRole
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/orgs/custom-roles#update-a-custom-repository-role
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/role-id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/organization-custom-repository-role-update-schema'
examples:
default:
value:
name: Labeler
description: A role for issue and PR labelers
base_role: read
permissions:
- add_label
- remove_label
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/organization-custom-repository-role'
examples:
default:
$ref: '#/components/examples/organization-custom-repository-role-example'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: true
enabledForGitHubApps: true
category: orgs
subcategory: custom-roles
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/dependabot/secrets/{secret_name}:
put:
summary: GitHub Create or Update an Organization Secret
description: 'Creates or updates an organization secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)."
OAuth app tokens and personal access tokens (classic) need the `admin:org` scope to use this endpoint.'
tags:
- Update
operationId: createOrUpdateAnOrganizationSecret
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-an-organization-secret
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/secret-name'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
encrypted_value:
type: string
description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-an-organization-public-key) endpoint.
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
key_id:
type: string
description: ID of the key you used to encrypt the secret.
visibility:
type: string
description: Which type of organization repositories have access to the organization secret. `selected` means only the repositories specified by `selected_repository_ids` can access the secret.
enum:
- all
- private
- selected
selected_repository_ids:
type: array
description: An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#remove-selected-repository-from-an-organization-secret) endpoints.
items:
type: string
required:
- visibility
examples:
default:
value:
encrypted_value: c2VjcmV0
key_id: 012345678912345678
visibility: selected
selected_repository_ids:
- '1296269'
- '1296280'
responses:
'201':
description: Response when creating a secret
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object'
examples:
default:
value: null
'204':
description: Response when updating a secret
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: dependabot
subcategory: secrets
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/hooks/{hook_id}:
patch:
summary: GitHub Update an Organization Webhook
description: Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for an organization](/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization)."
tags:
- Update
operationId: updateAnOrganizationWebhook
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#update-an-organization-webhook
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/hook-id'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
config:
type: object
description: Key/value pairs to provide settings for this webhook.
properties:
url:
$ref: '#/components/schemas/webhook-config-url'
content_type:
$ref: '#/components/schemas/webhook-config-content-type'
secret:
$ref: '#/components/schemas/webhook-config-secret'
insecure_ssl:
$ref: '#/components/schemas/webhook-config-insecure-ssl'
required:
- url
events:
type: array
description: Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for.
default:
- push
items:
type: string
active:
type: boolean
description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
default: true
name:
type: string
example: '"web"'
examples:
default:
value:
active: true
events:
- pull_request
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/org-hook'
examples:
default:
$ref: '#/components/examples/org-hook-2'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: webhooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/hooks/{hook_id}/config:
patch:
summary: GitHub Update Webhook Configuration for an Organization
description: 'Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use "[Update an organization webhook ](/rest/orgs/webhooks#update-an-organization-webhook)."
OAuth app tokens and personal access tokens (classic) need the `admin:org_hook` scope to use this endpoint.'
tags:
- Update
operationId: updateWebhookConfigurationForAnOrganization
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/orgs/webhooks#update-a-webhook-configuration-for-an-organization
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/hook-id'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
url:
$ref: '#/components/schemas/webhook-config-url'
content_type:
$ref: '#/components/schemas/webhook-config-content-type'
secret:
$ref: '#/components/schemas/webhook-config-secret'
insecure_ssl:
$ref: '#/components/schemas/webhook-config-insecure-ssl'
examples:
default:
summary: Update an existing webhook
value:
url: http://example.com/webhook
content_type: json
insecure_ssl: '0'
secret: '********'
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-config'
examples:
default:
$ref: '#/components/examples/webhook-config'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: webhooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/pre-receive-hooks/{pre_receive_hook_id}:
patch:
summary: GitHub Update Pre-receive Hook Enforcement for an Organization
description: For pre-receive hooks which are allowed to be configured at the org level, you can set `enforcement` and `allow_downstream_configuration`
operationId: updatePrereceiveHookEnforcementForAnOrganization
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/org-pre-receive-hooks#update-pre-receive-hook-enforcement-for-an-organization
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/pre-receive-hook-id'
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/org-pre-receive-hook'
examples:
default:
$ref: '#/components/examples/org-pre-receive-hook-2'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
enforcement:
description: The state of enforcement for the hook on this repository.
type: string
allow_downstream_configuration:
description: Whether repositories can override enforcement.
type: boolean
examples:
default:
value:
enforcement: enabled
allow_downstream_configuration: false
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: enterprise-admin
subcategory: org-pre-receive-hooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}:
patch:
summary: GitHub Update Team
description: 'To edit a team, the authenticated user must either be an organization owner or a team maintainer.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.'
tags:
- Update
operationId: updateTeam
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the team.
description:
type: string
description: The description of the team.
privacy:
type: string
description: "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization."
enum:
- secret
- closed
permission:
type: string
description: '**Deprecated**. The permission that new repositories will be added to the team with when none is specified.'
enum:
- pull
- push
- admin
default: pull
parent_team_id:
type: integer
description: The ID of a team to set as the parent team.
nullable: true
examples:
default:
value:
name: new team name
description: new team description
privacy: closed
responses:
'200':
description: Response when the updated information already exists
content:
application/json:
schema:
$ref: '#/components/schemas/team-full'
examples:
default:
$ref: '#/components/examples/team-full'
'201':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-full'
examples:
default:
$ref: '#/components/examples/team-full'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: teams
subcategory: teams
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}:
patch:
summary: GitHub Update Discussion
description: 'Edits the title and body text of a discussion post. Only the parameters you provide are updated.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.
OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.'
tags:
- Update
operationId: updateDiscussion
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
- $ref: '#/components/parameters/discussion-number'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: The discussion post's title.
body:
type: string
description: The discussion post's body text.
examples:
default:
value:
title: Welcome to our first team post
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-discussion'
examples:
default:
$ref: '#/components/examples/team-discussion-2'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: teams
subcategory: discussions
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}:
patch:
summary: GitHub Update Discussion Comment
description: 'Edits the body text of a discussion comment.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.
OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.'
tags:
- Update
operationId: updateDiscussionComment
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
- $ref: '#/components/parameters/discussion-number'
- $ref: '#/components/parameters/comment-number'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
body:
type: string
description: The discussion comment's body text.
required:
- body
examples:
default:
value:
body: Do you like pineapples?
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-discussion-comment'
examples:
default:
$ref: '#/components/examples/team-discussion-comment-2'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: teams
subcategory: discussion-comments
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}/external-groups:
patch:
summary: GitHub Update the Connection Between an External Group and Team
description: 'Creates a connection between a team and an external group. Only one external group can be linked to a team.
You can manage team membership with your identity provider using Enterprise Managed Users for GitHub Enterprise Cloud. For more information, see "[GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products)" in the GitHub Help documentation.'
tags:
- Update
operationId: updateTheConnectionBetweenAnExternalGroupAndTeam
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/external-groups#update-the-connection-between-an-external-group-and-a-team
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
group_id:
type: integer
description: External Group Id
example: 1
required:
- group_id
examples:
default:
value:
group_id: 123
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/external-group'
examples:
default:
$ref: '#/components/examples/external-group'
x-github:
githubCloudOnly: true
enabledForGitHubApps: false
category: teams
subcategory: external-groups
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}/memberships/{username}:
put:
summary: GitHub Add or Update Team Membership for User
description: 'Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
**Note:** When you have team synchronization set up for a team with your organization''s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team''s membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
An organization owner can add someone who is not part of the team''s organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the "pending" state until the person accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team.
If the user is already a member of the team, this endpoint will update the role of the team member''s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.'
tags:
- Update
operationId: addOrUpdateTeamMembershipForUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
- $ref: '#/components/parameters/username'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
role:
type: string
description: The role that this user should have in the team.
enum:
- member
- maintainer
default: member
examples:
default:
summary: Add or update team membership for an organization member
value:
role: maintainer
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-membership'
examples:
response-if-users-membership-with-team-is-now-pending:
$ref: '#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending'
'403':
description: Forbidden if team synchronization is set up
'422':
description: Unprocessable Entity if you attempt to add an organization to a team
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: teams
subcategory: members
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}/projects/{project_id}:
put:
summary: GitHub Add or Update Team Project Permissions
description: 'Adds an organization project to a team. To add a project to a team or update the team''s permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.'
tags:
- Update
operationId: addOrUpdateTeamProjectPermissions
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
- $ref: '#/components/parameters/project-id'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
permission:
type: string
description: 'The permission to grant to the team for this project. Default: the team''s `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)."'
enum:
- read
- write
- admin
nullable: true
examples:
default:
summary: Updates the permissions for the team to write for the project
value:
permission: write
responses:
'204':
description: Response
'403':
description: Forbidden if the project is not owned by the organization
content:
application/json:
schema:
type: object
properties:
message:
type: string
documentation_url:
type: string
examples:
response-if-the-project-is-not-owned-by-the-organization:
value:
message: Must have admin rights to Repository.
documentation_url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: teams
subcategory: teams
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}:
put:
summary: GitHub Add or Update Team Repository Permissions
description: 'To add a repository to a team or update the team''s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)."
**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.
For more information about the permission levels, see "[Repository permission levels for an organization](https://docs.github.com/enterprise-server@3.9/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)".'
tags:
- Update
operationId: addOrUpdateTeamRepositoryPermissions
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions
parameters:
- $ref: '#/components/parameters/org'
- $ref: '#/components/parameters/team-slug'
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
permission:
type: string
description: 'The permission to grant the team on this repository. We accept the following permissions to be set: `pull`, `triage`, `push`, `maintain`, `admin` and you can also specify a custom repository role name, if the owning organization has defined any. If no permission is specified, the team''s `permission` attribute will be used to determine what permission to grant the team on this repository.'
default: push
examples:
default:
summary: Adding a team to an organization repository with the write role
value:
permission: push
responses:
'204':
description: Response
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: teams
subcategory: teams
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/projects/columns/cards/{card_id}:
patch:
summary: GitHub Update an Existing Project Card
description: The PATCH operation on the `/projects/columns/cards/{card_id}` endpoint allows you to modify an existing project card within a GitHub project board by providing the card's unique identifier. This API call enables you to update card properties such as the note content or archived status, giving you programmatic control over managing cards in your project workflows. You must authenticate with appropriate permissions to modify cards, and the endpoint returns the updated card object upon successful execution. This is particularly useful for automation scenarios where you need to dynamically update card information, move cards between states, or archive cards based on project progress without manually interacting with the GitHub web interface.
tags:
- Update
operationId: updateAnExistingProjectCard
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/projects/cards#update-an-existing-project-card
parameters:
- $ref: '#/components/parameters/card-id'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
note:
description: The project card's note
example: Update all gems
type: string
nullable: true
archived:
description: Whether or not the card is archived
example: false
type: boolean
examples:
default:
summary: Change the note on the card
value:
note: Add payload for delete Project column
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/project-card'
examples:
default:
$ref: '#/components/examples/project-card'
'304':
$ref: '#/components/responses/not_modified'
'401':
$ref: '#/components/responses/requires_authentication'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed_simple'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: projects
subcategory: cards
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/projects/columns/{column_id}:
patch:
summary: GitHub Update an Existing Project Column
description: The PATCH operation on the /projects/columns/{column_id} endpoint allows developers to modify the properties of an existing project column within GitHub Projects. By sending a PATCH request with the column's unique identifier, users can update attributes such as the column's name. This endpoint is particularly useful for reorganizing project boards, renaming workflow stages, or adjusting column configurations without needing to delete and recreate columns. The operation requires appropriate authentication and permissions to modify the project column, and it returns the updated column object upon successful execution, maintaining the column's position and associated cards while applying the requested changes.
tags:
- Update
operationId: updateAnExistingProjectColumn
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/projects/columns#update-an-existing-project-column
parameters:
- $ref: '#/components/parameters/column-id'
requestBody:
required: true
content:
application/json:
schema:
properties:
name:
description: Name of the project column
example: Remaining tasks
type: string
required:
- name
type: object
examples:
default:
summary: Rename the project column
value:
name: To Do
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/project-column'
examples:
default:
$ref: '#/components/examples/project-column'
'304':
$ref: '#/components/responses/not_modified'
'401':
$ref: '#/components/responses/requires_authentication'
'403':
$ref: '#/components/responses/forbidden'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: projects
subcategory: columns
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/projects/{project_id}:
patch:
summary: GitHub Update Project
description: The Update Project operation is a PATCH request to the /projects/{project_id} endpoint that allows you to modify an existing GitHub project's properties. By providing the project's unique identifier in the URL path, you can update various attributes such as the project's name, description (body), state (open or closed), organization permission levels, and privacy settings. This endpoint requires appropriate authentication and permissions to modify the project, and it returns the updated project object with all its current properties upon successful execution. The PATCH method enables partial updates, meaning you only need to include the specific fields you want to change rather than sending the entire project object.
operationId: updateProject
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/projects/projects#update-a-project
parameters:
- $ref: '#/components/parameters/project-id'
requestBody:
required: false
content:
application/json:
schema:
properties:
name:
description: Name of the project
example: Week One Sprint
type: string
body:
description: Body of the project
example: This project represents the sprint of the first week in January
type: string
nullable: true
state:
description: State of the project; either 'open' or 'closed'
example: open
type: string
organization_permission:
description: The baseline permission that all organization members have on this project
type: string
enum:
- read
- write
- admin
- none
private:
description: Whether or not this project can be seen by everyone.
type: boolean
type: object
examples:
default:
summary: Change the name, state, and permissions for a project
value:
name: Week One Sprint
state: open
organization_permission: write
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/project'
examples:
default:
$ref: '#/components/examples/project-3'
'304':
$ref: '#/components/responses/not_modified'
'401':
$ref: '#/components/responses/requires_authentication'
'403':
description: Forbidden
content:
application/json:
schema:
type: object
properties:
message:
type: string
documentation_url:
type: string
errors:
type: array
items:
type: string
'404':
description: Not Found if the authenticated user does not have access to the project
'410':
$ref: '#/components/responses/gone'
'422':
$ref: '#/components/responses/validation_failed_simple'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: projects
subcategory: projects
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/teams/{team_id}/projects/{project_id}:
put:
summary: GitHub Add or Update Team Project Permissions (legacy)
description: '**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team project permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions) endpoint.
Adds an organization project to a team. To add a project to a team or update the team''s permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.'
tags:
- Update
operationId: addOrUpdateTeamProjectPermissionsLegacy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions-legacy
parameters:
- $ref: '#/components/parameters/team-id'
- $ref: '#/components/parameters/project-id'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
permission:
type: string
description: 'The permission to grant to the team for this project. Default: the team''s `permission` attribute will be used to determine what permission to grant the team on this project. Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)."'
enum:
- read
- write
- admin
examples:
default:
summary: Example of setting permission to read
value:
permission: read
responses:
'204':
description: Response
'403':
description: Forbidden if the project is not owned by the organization
content:
application/json:
schema:
type: object
properties:
message:
type: string
documentation_url:
type: string
examples:
response-if-the-project-is-not-owned-by-the-organization:
value:
message: Must have admin rights to Repository.
documentation_url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-project-permissions
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
category: teams
subcategory: teams
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/secrets/{secret_name}:
put:
summary: GitHub Create or Update Repository Secret
description: 'Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)."
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: createOrUpdateRepositorySecret
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-a-repository-secret
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/secret-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
encrypted_value:
type: string
description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get repository public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-a-repository-public-key) endpoint.
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
key_id:
type: string
description: ID of the key you used to encrypt the secret.
examples:
default:
value:
encrypted_value: c2VjcmV0
key_id: 012345678912345678
responses:
'201':
description: Response when creating a secret
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object_2'
examples:
default:
value: {}
'204':
description: Response when updating a secret
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: secrets
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/actions/variables/{name}:
patch:
summary: GitHub Update Repository Variable
description: 'Updates a repository variable that you can reference in a GitHub Actions workflow.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: updateRepositoryVariable
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-a-repository-variable
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/variable-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the variable.
value:
type: string
description: The value of the variable.
examples:
default:
value:
name: USERNAME
value: octocat
responses:
'204':
description: Response
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: variables
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/branches/{branch}/protection:
put:
summary: GitHub Update Branch Protection
description: 'Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Protecting a branch requires admin or owner permissions to the repository.
**Note**: Passing new arrays of `users` and `teams` replaces their previous values.
**Note**: The list of users, apps, and teams in total is limited to 100 items.'
tags:
- Update
operationId: updateBranchProtection
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#update-branch-protection
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/branch'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
required_status_checks:
type: object
description: Require status checks to pass before merging. Set to `null` to disable.
properties:
strict:
type: boolean
description: Require branches to be up to date before merging.
contexts:
type: array
deprecated: true
description: '**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
'
items:
type: string
checks:
type: array
description: The list of status checks to require in order to merge into this branch.
items:
type: object
required:
- context
properties:
context:
type: string
description: The name of the required check
app_id:
type: integer
description: The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
required:
- strict
- contexts
enforce_admins:
type: boolean
description: Enforce all configured restrictions for administrators. Set to `true` to enforce required status checks for repository administrators. Set to `null` to disable.
required_pull_request_reviews:
type: object
description: Require at least one approving review on a pull request, before merging. Set to `null` to disable.
properties:
dismissal_restrictions:
type: object
description: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.
properties:
users:
type: array
description: The list of user `login`s with dismissal access
items:
type: string
teams:
type: array
description: The list of team `slug`s with dismissal access
items:
type: string
apps:
type: array
description: The list of app `slug`s with dismissal access
items:
type: string
dismiss_stale_reviews:
type: boolean
description: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.
require_code_owner_reviews:
type: boolean
description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.9/articles/about-code-owners/) review them.
required_approving_review_count:
type: integer
description: Specify the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
require_last_push_approval:
type: boolean
description: 'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`.'
default: false
bypass_pull_request_allowances:
type: object
description: Allow specific users, teams, or apps to bypass pull request requirements.
properties:
users:
type: array
description: The list of user `login`s allowed to bypass pull request requirements.
items:
type: string
teams:
type: array
description: The list of team `slug`s allowed to bypass pull request requirements.
items:
type: string
apps:
type: array
description: The list of app `slug`s allowed to bypass pull request requirements.
items:
type: string
restrictions:
type: object
description: Restrict who can push to the protected branch. User, app, and team `restrictions` are only available for organization-owned repositories. Set to `null` to disable.
properties:
users:
type: array
description: The list of user `login`s with push access
items:
type: string
teams:
type: array
description: The list of team `slug`s with push access
items:
type: string
apps:
type: array
description: The list of app `slug`s with push access
items:
type: string
required:
- users
- teams
required_linear_history:
type: boolean
description: 'Enforces a linear commit Git history, which prevents anyone from pushing merge commits to a branch. Set to `true` to enforce a linear commit history. Set to `false` to disable a linear commit Git history. Your repository must allow squash merging or rebase merging before you can enable a linear commit history. Default: `false`. For more information, see "[Requiring a linear commit history](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/requiring-a-linear-commit-history)" in the GitHub Help documentation.'
allow_force_pushes:
type: boolean
description: 'Permits force pushes to the protected branch by anyone with write access to the repository. Set to `true` to allow force pushes. Set to `false` or `null` to block force pushes. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation."'
allow_deletions:
type: boolean
description: 'Allows deletion of the protected branch by anyone with write access to the repository. Set to `false` to prevent deletion of the protected branch. Default: `false`. For more information, see "[Enabling force pushes to a protected branch](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/enabling-force-pushes-to-a-protected-branch)" in the GitHub Help documentation.'
block_creations:
type: boolean
description: 'If set to `true`, the `restrictions` branch protection settings which limits who can push will also block pushes which create new branches, unless the push is initiated by a user, team, or app which has the ability to push. Set to `true` to restrict new branch creation. Default: `false`.'
required_conversation_resolution:
type: boolean
description: 'Requires all conversations on code to be resolved before a pull request can be merged into a branch that matches this rule. Set to `false` to disable. Default: `false`.'
lock_branch:
type: boolean
description: 'Whether to set the branch as read-only. If this is true, users will not be able to push to the branch. Default: `false`.'
default: false
allow_fork_syncing:
type: boolean
description: 'Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing. Default: `false`.'
default: false
required:
- required_status_checks
- enforce_admins
- required_pull_request_reviews
- restrictions
examples:
default:
value:
required_status_checks:
strict: true
contexts:
- continuous-integration/travis-ci
enforce_admins: true
required_pull_request_reviews:
dismissal_restrictions:
users:
- octocat
teams:
- justice-league
dismiss_stale_reviews: true
require_code_owner_reviews: true
required_approving_review_count: 2
require_last_push_approval: true
bypass_pull_request_allowances:
users:
- octocat
teams:
- justice-league
restrictions:
users:
- octocat
teams:
- justice-league
apps:
- super-ci
required_linear_history: true
allow_force_pushes: true
allow_deletions: true
block_creations: true
required_conversation_resolution: true
lock_branch: true
allow_fork_syncing: true
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/protected-branch'
examples:
default:
$ref: '#/components/examples/branch-protection-update'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed_simple'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: branches
subcategory: branch-protection
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/branches/{branch}/protection/required_pull_request_reviews:
patch:
summary: GitHub Update Pull Request Review Protection
description: 'Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Updating pull request review enforcement requires admin or owner permissions to the repository and branch protection to be enabled.
**Note**: Passing new arrays of `users` and `teams` replaces their previous values.'
tags:
- Update
operationId: updatePullRequestReviewProtection
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#update-pull-request-review-protection
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/branch'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
dismissal_restrictions:
type: object
description: Specify which users, teams, and apps can dismiss pull request reviews. Pass an empty `dismissal_restrictions` object to disable. User and team `dismissal_restrictions` are only available for organization-owned repositories. Omit this parameter for personal repositories.
properties:
users:
type: array
description: The list of user `login`s with dismissal access
items:
type: string
teams:
type: array
description: The list of team `slug`s with dismissal access
items:
type: string
apps:
type: array
description: The list of app `slug`s with dismissal access
items:
type: string
dismiss_stale_reviews:
type: boolean
description: Set to `true` if you want to automatically dismiss approving reviews when someone pushes a new commit.
require_code_owner_reviews:
type: boolean
description: Blocks merging pull requests until [code owners](https://docs.github.com/enterprise-server@3.9/articles/about-code-owners/) have reviewed.
required_approving_review_count:
type: integer
description: Specifies the number of reviewers required to approve pull requests. Use a number between 1 and 6 or 0 to not require reviewers.
require_last_push_approval:
type: boolean
description: 'Whether the most recent push must be approved by someone other than the person who pushed it. Default: `false`'
default: false
bypass_pull_request_allowances:
type: object
description: Allow specific users, teams, or apps to bypass pull request requirements.
properties:
users:
type: array
description: The list of user `login`s allowed to bypass pull request requirements.
items:
type: string
teams:
type: array
description: The list of team `slug`s allowed to bypass pull request requirements.
items:
type: string
apps:
type: array
description: The list of app `slug`s allowed to bypass pull request requirements.
items:
type: string
examples:
default:
value:
dismissal_restrictions:
users:
- octocat
teams:
- justice-league
apps:
- octoapp
bypass_pull_request_allowances:
users:
- octocat
teams:
- justice-league
apps:
- octoapp
dismiss_stale_reviews: true
require_code_owner_reviews: true
required_approving_review_count: 2
require_last_push_approval: true
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/protected-branch-pull-request-review'
examples:
default:
$ref: '#/components/examples/protected-branch-pull-request-review'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: branches
subcategory: branch-protection
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/branches/{branch}/protection/required_status_checks:
patch:
summary: GitHub Update Status Check Protection
description: 'Protected branches are available in public repositories with GitHub Free and GitHub Free for organizations, and in public and private repositories with GitHub Pro, GitHub Team, GitHub Enterprise Cloud, and GitHub Enterprise Server. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
Updating required status checks requires admin or owner permissions to the repository and branch protection to be enabled.'
tags:
- Update
operationId: updateStatusCheckProtection
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection#update-status-check-protection
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/branch'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
strict:
type: boolean
description: Require branches to be up to date before merging.
contexts:
type: array
deprecated: true
description: '**Deprecated**: The list of status checks to require in order to merge into this branch. If any of these checks have recently been set by a particular GitHub App, they will be required to come from that app in future for the branch to merge. Use `checks` instead of `contexts` for more fine-grained control.
'
items:
type: string
checks:
type: array
description: The list of status checks to require in order to merge into this branch.
items:
type: object
required:
- context
properties:
context:
type: string
description: The name of the required check
app_id:
type: integer
description: The ID of the GitHub App that must provide this check. Omit this field to automatically select the GitHub App that has recently provided this check, or any app if it was not set by a GitHub App. Pass -1 to explicitly allow any app to set the status.
examples:
default:
value:
strict: true
contexts:
- continuous-integration/travis-ci
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/status-check-policy'
examples:
default:
$ref: '#/components/examples/status-check-policy'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: branches
subcategory: branch-protection
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}:
patch:
summary: GitHub Update Code Scanning Alert
description: 'Updates the status of a single code scanning alert.
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.'
operationId: updateCodeScanningAlert
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#update-a-code-scanning-alert
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/alert-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
state:
$ref: '#/components/schemas/code-scanning-alert-set-state'
dismissed_reason:
$ref: '#/components/schemas/code-scanning-alert-dismissed-reason'
dismissed_comment:
$ref: '#/components/schemas/code-scanning-alert-dismissed-comment'
required:
- state
examples:
default:
value:
state: dismissed
dismissed_reason: false positive
dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library.
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/code-scanning-alert'
examples:
default:
$ref: '#/components/examples/code-scanning-alert-dismissed'
'403':
$ref: '#/components/responses/code_scanning_forbidden_write'
'404':
$ref: '#/components/responses/not_found'
'503':
$ref: '#/components/responses/service_unavailable'
x-github:
enabledForGitHubApps: true
githubCloudOnly: false
category: code-scanning
subcategory: code-scanning
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/code-scanning/default-setup:
patch:
summary: GitHub Update Code Scanning Default Setup Configuration
description: 'Updates a code scanning default setup configuration.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint with private or public repositories, or the `public_repo` scope to use this endpoint with only public repositories.'
tags:
- Update
operationId: updateCodeScanningDefaultSetupConfiguration
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/code-scanning/code-scanning#update-a-code-scanning-default-setup-configuration
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/code-scanning-default-setup-update'
examples:
default:
$ref: '#/components/examples/code-scanning-default-setup-update'
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object_3'
examples:
default:
value: {}
'202':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/code-scanning-default-setup-update-response'
examples:
default:
$ref: '#/components/examples/code-scanning-default-setup-update-response'
'403':
$ref: '#/components/responses/code_scanning_forbidden_write'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/code_scanning_conflict'
'503':
$ref: '#/components/responses/service_unavailable'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: code-scanning
subcategory: code-scanning
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/dependabot/alerts/{alert_number}:
patch:
summary: GitHub Update Dependabot Alert
description: 'The authenticated user must have access to security alerts for the repository to use this endpoint. For more information, see "[Granting access to security alerts](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/enabling-features-for-your-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts)."
OAuth app tokens and personal access tokens (classic) need the `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.'
tags:
- Update
operationId: updateDependabotAlert
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts#update-a-dependabot-alert
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/dependabot-alert-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
state:
type: string
description: 'The state of the Dependabot alert.
`dismissed_reason` must be provided when setting the state to `dismissed`.'
enum:
- dismissed
- open
dismissed_reason:
type: string
description: '**Required when `state` is `dismissed`.** reason for dismissing the alert.'
enum:
- fix_started
- inaccurate
- no_bandwidth
- not_used
- tolerable_risk
dismissed_comment:
type: string
description: An optional comment associated with dismissing the alert.
maxLength: 280
required:
- state
additionalProperties: false
examples:
default:
value:
state: dismissed
dismissed_reason: tolerable_risk
dismissed_comment: This alert is accurate but we use a sanitizer.
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/dependabot-alert'
examples:
default:
$ref: '#/components/examples/dependabot-alert-dismissed'
'400':
$ref: '#/components/responses/bad_request'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict'
'422':
$ref: '#/components/responses/validation_failed_simple'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
previews: []
category: dependabot
subcategory: alerts
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/dependabot/secrets/{secret_name}:
put:
summary: GitHub Create or Update Repository Secret
description: 'Creates or updates a repository secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)."
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: createOrUpdateRepositoryDependabotSecret
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#create-or-update-a-repository-secret
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/secret-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
encrypted_value:
type: string
description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get repository public key](https://docs.github.com/enterprise-server@3.9/rest/dependabot/secrets#get-a-repository-public-key) endpoint.
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
key_id:
type: string
description: ID of the key you used to encrypt the secret.
examples:
default:
value:
encrypted_value: c2VjcmV0
key_id: 012345678912345678
responses:
'201':
description: Response when creating a secret
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object_4'
examples:
default:
value: {}
'204':
description: Response when updating a secret
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: dependabot
subcategory: secrets
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/hooks/{hook_id}:
patch:
summary: GitHub Update Repository Webhook
description: Updates a webhook configured in a repository. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use "[Update a webhook configuration for a repository](/rest/webhooks/repo-config#update-a-webhook-configuration-for-a-repository)."
tags:
- Update
operationId: updateRepositoryWebhook
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#update-a-repository-webhook
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/hook-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
config:
$ref: '#/components/schemas/webhook-config'
events:
type: array
description: Determines what [events](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads) the hook is triggered for. This replaces the entire array of events.
default:
- push
items:
type: string
add_events:
type: array
description: Determines a list of events to be added to the list of events that the Hook triggers for.
items:
type: string
remove_events:
type: array
description: Determines a list of events to be removed from the list of events that the Hook triggers for.
items:
type: string
active:
type: boolean
description: Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.
default: true
examples:
default:
value:
active: true
add_events:
- pull_request
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/hook'
examples:
default:
$ref: '#/components/examples/hook'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: repos
subcategory: webhooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/hooks/{hook_id}/config:
patch:
summary: GitHub Update Webhook Configuration for Repository
description: 'Updates the webhook configuration for a repository. To update more information about the webhook, including the `active` state and `events`, use "[Update a repository webhook](/rest/webhooks/repos#update-a-repository-webhook)."
OAuth app tokens and personal access tokens (classic) need the `write:repo_hook` or `repo` scope to use this endpoint.'
tags:
- Update
operationId: updateWebhookConfigurationForRepository
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/repos/webhooks#update-a-webhook-configuration-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/hook-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
additionalProperties: false
properties:
url:
$ref: '#/components/schemas/webhook-config-url'
content_type:
$ref: '#/components/schemas/webhook-config-content-type'
secret:
$ref: '#/components/schemas/webhook-config-secret'
insecure_ssl:
$ref: '#/components/schemas/webhook-config-insecure-ssl'
examples:
default:
summary: Example of updating content type and URL
value:
content_type: json
url: https://example.com/webhook
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-config'
examples:
default:
$ref: '#/components/examples/webhook-config'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: repos
subcategory: webhooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/pre-receive-hooks/{pre_receive_hook_id}:
patch:
summary: GitHub Update Pre-receive Hook Enforcement for Repository
description: For pre-receive hooks which are allowed to be configured at the repo level, you can set `enforcement`
operationId: updatePrereceiveHookEnforcementForRepository
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/repo-pre-receive-hooks#update-pre-receive-hook-enforcement-for-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/pre-receive-hook-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/repository-pre-receive-hook'
examples:
default:
$ref: '#/components/examples/repository-pre-receive-hook-2'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
enforcement:
description: The state of enforcement for the hook on this repository.
type: string
enum:
- enabled
- disabled
- testing
examples:
default:
value:
enforcement: enabled
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: enterprise-admin
subcategory: repo-pre-receive-hooks
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/invitations/{invitation_id}:
patch:
summary: GitHub Update Repository Invitation
description: This API endpoint allows you to update an existing repository invitation by modifying its permissions level. You must authenticate as a repository owner or administrator and provide the invitation ID in the URL path. The PATCH request accepts a JSON body with a 'permissions' field that can be set to 'read', 'write', 'maintain', 'triage', or 'admin' to change the access level being offered to the invited user. Upon successful execution, it returns the updated invitation object containing details such as the invitation ID, invitee information, permissions level, and creation timestamp. This is useful when you need to adjust the access rights of a pending invitation before it has been accepted by the recipient.
tags:
- Update
operationId: updateRepositoryInvitation
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#update-a-repository-invitation
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/invitation-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
permissions:
type: string
description: The permissions that the associated user will have on the repository. Valid values are `read`, `write`, `maintain`, `triage`, and `admin`.
enum:
- read
- write
- maintain
- triage
- admin
examples:
default:
summary: Example request body
value:
permissions: write
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/repository-invitation'
examples:
default:
$ref: '#/components/examples/repository-invitation'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: collaborators
subcategory: invitations
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/pulls/comments/{comment_id}:
patch:
summary: GitHub Update Review Comment for Pull Request
description: 'Edits the content of a specified review comment.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.'
tags:
- Update
operationId: updateReviewCommentForPullRequest
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#update-a-review-comment-for-a-pull-request
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/comment-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
body:
type: string
description: The text of the reply to the review comment.
required:
- body
examples:
default:
value:
body: I like this too!
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/pull-request-review-comment'
examples:
default:
$ref: '#/components/examples/pull-request-review-comment-2'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: comments
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/pulls/{pull_number}:
patch:
summary: GitHub Update Pull Request
description: 'Draft pull requests are available in public repositories with GitHub Free and GitHub Free for organizations, GitHub Pro, and legacy per-repository billing plans, and in public and private repositories with GitHub Team and GitHub Enterprise Cloud. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
To open or update a pull request in a public repository, you must have write access to the head or the source branch. For organization-owned repositories, you must be a member of the organization that owns the repository to open or update a pull request.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`.
- **`application/vnd.github.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.
- **`application/vnd.github.diff`**: For more information, see "[git-diff](https://git-scm.com/docs/git-diff)" in the Git documentation. If a diff is corrupt, contact us through the [GitHub Support portal](https://support.github.com/). Include the repository name and pull request ID in your message.'
tags:
- Update
operationId: updatePullRequest
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/pull-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: The title of the pull request.
body:
type: string
description: The contents of the pull request.
state:
type: string
description: State of this Pull Request. Either `open` or `closed`.
enum:
- open
- closed
base:
type: string
description: The name of the branch you want your changes pulled into. This should be an existing branch on the current repository. You cannot update the base branch on a pull request to point to another repository.
maintainer_can_modify:
type: boolean
description: Indicates whether [maintainers can modify](https://docs.github.com/enterprise-server@3.9/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork/) the pull request.
examples:
default:
value:
title: new title
body: updated body
state: open
base: master
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/pull-request'
examples:
default:
$ref: '#/components/examples/pull-request'
'403':
$ref: '#/components/responses/forbidden'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: pulls
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/pulls/{pull_number}/reviews/{review_id}:
put:
summary: GitHub Update Review for Pull Request
description: 'Updates the contents of a specified review summary comment.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.'
tags:
- Update
operationId: updateReviewForPullRequest
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews#update-a-review-for-a-pull-request
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/pull-number'
- $ref: '#/components/parameters/review-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
body:
type: string
description: The body text of the pull request review.
required:
- body
examples:
default:
value:
body: This is close to perfect! Please address the suggested inline change. And add more about this.
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/pull-request-review'
examples:
default:
$ref: '#/components/examples/pull-request-review-5'
'422':
$ref: '#/components/responses/validation_failed_simple'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pulls
subcategory: reviews
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/pulls/{pull_number}/update-branch:
put:
summary: GitHub Update Pull Request Branch
description: Updates the pull request branch with the latest upstream changes by merging HEAD from the base branch into the pull request branch.
tags:
- Update
operationId: updatePullRequestBranch
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#update-a-pull-request-branch
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/pull-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
expected_head_sha:
type: string
description: 'The expected SHA of the pull request''s HEAD ref. This is the most recent commit on the pull request''s branch. If the expected SHA does not match the pull request''s HEAD, you will receive a `422 Unprocessable Entity` status. You can use the "[List commits](https://docs.github.com/enterprise-server@3.9/rest/commits/commits#list-commits)" endpoint to find the most recent commit SHA. Default: SHA of the pull request''s current HEAD ref.'
examples:
default:
value:
expected_head_sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
responses:
'202':
description: Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
url:
type: string
examples:
default:
value:
message: Updating pull request branch.
url: https://github.com/repos/octocat/Hello-World/pulls/53
'403':
$ref: '#/components/responses/forbidden'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: pulls
subcategory: pulls
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}:
patch:
summary: GitHub Update Repository
description: '**Note**: To edit a repository''s topics, use the [Replace all repository topics](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#replace-all-repository-topics) endpoint.'
tags:
- Update
operationId: updateRepository
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/repos/repos#update-a-repository
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the repository.
description:
type: string
description: short description of the repository.
homepage:
type: string
description: URL with more information about the repository.
private:
type: boolean
description: 'Either `true` to make the repository private or `false` to make it public. Default: `false`.
**Note**: You will Get `422` error if the organization restricts [changing repository visibility](https://docs.github.com/enterprise-server@3.9/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.'
default: false
visibility:
type: string
description: The visibility of the repository.
enum:
- public
- private
- internal
security_and_analysis:
type: object
description: 'Specify which security and analysis features to enable or disable for the repository.
To use this parameter, you must have admin permissions for the repository or be an owner or security manager for the organization that owns the repository. For more information, see "[Managing security managers in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-peoples-access-to-your-organization-with-roles/managing-security-managers-in-your-organization)."
For example, to enable GitHub Advanced Security, use this data in the body of the `PATCH` request:
`{ "security_and_analysis": {"advanced_security": { "status": "enabled" } } }`.
You can check which security and analysis features are currently enabled by using a `GET /repos/{owner}/{repo}` request.'
properties:
advanced_security:
type: object
description: Use the `status` property to enable or disable GitHub Advanced Security for this repository. For more information, see "[About GitHub Advanced Security](/github/getting-started-with-github/learning-about-github/about-github-advanced-security)."
properties:
status:
type: string
description: Can be `enabled` or `disabled`.
secret_scanning:
type: object
description: Use the `status` property to enable or disable secret scanning for this repository. For more information, see "[About secret scanning](/code-security/secret-security/about-secret-scanning)."
properties:
status:
type: string
description: Can be `enabled` or `disabled`.
secret_scanning_push_protection:
type: object
description: Use the `status` property to enable or disable secret scanning push protection for this repository. For more information, see "[Protecting pushes with secret scanning](/code-security/secret-scanning/protecting-pushes-with-secret-scanning)."
properties:
status:
type: string
description: Can be `enabled` or `disabled`.
has_issues:
type: boolean
description: Either `true` to enable issues for this repository or `false` to disable them.
default: true
has_projects:
type: boolean
description: Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.
default: true
has_wiki:
type: boolean
description: Either `true` to enable the wiki for this repository or `false` to disable it.
default: true
is_template:
type: boolean
description: Either `true` to make this repo available as a template repository or `false` to prevent it.
default: false
default_branch:
type: string
description: Updates the default branch for this repository.
allow_squash_merge:
type: boolean
description: Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.
default: true
allow_merge_commit:
type: boolean
description: Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.
default: true
allow_rebase_merge:
type: boolean
description: Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.
default: true
delete_branch_on_merge:
type: boolean
description: Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.
default: false
allow_update_branch:
type: boolean
description: Either `true` to always allow a pull request head branch that is behind its base branch to be updated even if it is not required to be up to date before merging, or false otherwise.
default: false
use_squash_pr_title_as_default:
type: boolean
description: Either `true` to allow squash-merge commits to use pull request title, or `false` to use commit message. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: 'The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request''s title.
- `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).'
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: 'The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request''s body.
- `COMMIT_MESSAGES` - default to the branch''s commit messages.
- `BLANK` - default to a blank commit message.'
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: 'The default value for a merge commit title.
- `PR_TITLE` - default to the pull request''s title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).'
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: 'The default value for a merge commit message.
- `PR_TITLE` - default to the pull request''s title.
- `PR_BODY` - default to the pull request''s body.
- `BLANK` - default to a blank commit message.'
archived:
type: boolean
description: Whether to archive this repository. `false` will unarchive a previously archived repository.
default: false
allow_forking:
type: boolean
description: Either `true` to allow private forks, or `false` to prevent private forks.
default: false
web_commit_signoff_required:
type: boolean
description: Either `true` to require contributors to sign off on web-based commits, or `false` to not require contributors to sign off on web-based commits.
default: false
examples:
default:
value:
name: Hello-World
description: This is your first repository
homepage: https://github.com
private: true
has_issues: true
has_projects: true
has_wiki: true
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/full-repository'
examples:
default:
$ref: '#/components/examples/full-repository'
'307':
$ref: '#/components/responses/temporary_redirect'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: repos
subcategory: repos
previews:
- required: false
name: nebula
note: 'You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/enterprise-server@3.9/rest/repos), and Get repository''s visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).
To access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types) in the `Accept` header:
```shell
application/vnd.github.nebula-preview+json
```'
- required: false
name: baptiste
note: 'The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/enterprise-server@3.9/rest/overview/media-types) in the `Accept` header:
```shell
application/vnd.github.baptiste-preview+json
```'
x-api-evangelist-certified: '2025-07-18'
x-api-naftiko-published: '2025-07-25'
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/check-runs/{check_run_id}:
patch:
summary: GitHub Update Check Run
description: 'Updates a check run for a specific commit in a repository.
**Note:** The endpoints to manage checks only look for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.
OAuth apps and personal access tokens (classic) cannot use this endpoint.'
tags:
- Update
operationId: updateCheckRun
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/check-run-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the check. For example, "code-coverage".
details_url:
type: string
description: The URL of the integrator's site that has the full details of the check.
external_id:
type: string
description: reference for the run on the integrator's system.
started_at:
type: string
format: date-time
description: 'This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
status:
type: string
description: The current status.
enum:
- queued
- in_progress
- completed
conclusion:
type: string
description: '**Required if you provide `completed_at` or a `status` of `completed`**. The final conclusion of the check.
**Note:** Providing `conclusion` will automatically set the `status` parameter to `completed`. You cannot change a check run conclusion to `stale`, only GitHub can set this.'
enum:
- action_required
- cancelled
- failure
- neutral
- success
- skipped
- stale
- timed_out
completed_at:
type: string
format: date-time
description: 'The time the check completed. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
output:
type: object
description: Check runs can accept a variety of data in the `output` object, including a `title` and `summary` and can optionally provide descriptive details about the run.
properties:
title:
type: string
description: '**Required**.'
summary:
type: string
description: Can contain Markdown.
maxLength: 65535
text:
type: string
description: Can contain Markdown.
maxLength: 65535
annotations:
type: array
description: Adds information from your analysis to specific lines of code. Annotations are visible in GitHub's pull request UI. Annotations are visible in GitHub's pull request UI. The Checks API limits the number of annotations to a maximum of 50 per API request. To create more than 50 annotations, you have to make multiple requests to the [Update a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#update-a-check-run) endpoint. Each time you update the check run, annotations are appended to the list of annotations that already exist for the check run. GitHub Actions are limited to 10 warning annotations and 10 error annotations per step. For details about annotations in the UI, see "[About status checks](https://docs.github.com/enterprise-server@3.9/articles/about-status-checks#checks)".
maxItems: 50
items:
type: object
properties:
path:
type: string
description: The path of the file to add an annotation to. For example, `assets/css/main.css`.
start_line:
type: integer
description: The start line of the annotation. Line numbers start at 1.
end_line:
type: integer
description: The end line of the annotation.
start_column:
type: integer
description: The start column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values. Column numbers start at 1.
end_column:
type: integer
description: The end column of the annotation. Annotations only support `start_column` and `end_column` on the same line. Omit this parameter if `start_line` and `end_line` have different values.
annotation_level:
type: string
description: The level of the annotation.
enum:
- notice
- warning
- failure
message:
type: string
description: short description of the feedback for these lines of code. The maximum size is 64 KB.
title:
type: string
description: The title that represents the annotation. The maximum size is 255 characters.
raw_details:
type: string
description: Details about this annotation. The maximum size is 64 KB.
required:
- path
- start_line
- end_line
- annotation_level
- message
images:
type: array
description: Adds images to the output displayed in the GitHub pull request UI.
items:
type: object
properties:
alt:
type: string
description: The alternative text for the image.
image_url:
type: string
description: The full URL of the image.
caption:
type: string
description: short image description.
required:
- alt
- image_url
required:
- summary
actions:
type: array
description: Possible further actions the integrator can perform, which a user may trigger. Each action includes a `label`, `identifier` and `description`. maximum of three actions are accepted. To learn more about check runs and requested actions, see "[Check runs and requested actions](https://docs.github.com/enterprise-server@3.9/rest/guides/using-the-rest-api-to-interact-with-checks#check-runs-and-requested-actions)."
maxItems: 3
items:
type: object
properties:
label:
type: string
maxLength: 20
description: The text to be displayed on a button in the web UI. The maximum size is 20 characters.
description:
type: string
maxLength: 40
description: short explanation of what this action would do. The maximum size is 40 characters.
identifier:
type: string
maxLength: 20
description: reference for the action on the integrator's system. The maximum size is 20 characters.
required:
- label
- description
- identifier
anyOf:
- properties:
status:
enum:
- completed
required:
- conclusion
additionalProperties: true
- properties:
status:
enum:
- queued
- in_progress
additionalProperties: true
examples:
default:
value:
name: mighty_readme
started_at: '2018-05-04T01:14:52Z'
status: completed
conclusion: success
completed_at: '2018-05-04T01:14:52Z'
output:
title: Mighty Readme report
summary: There are 0 failures, 2 warnings, and 1 notices.
text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.
annotations:
- path: README.md
annotation_level: warning
title: Spell Checker
message: Check your spelling for 'banaas'.
raw_details: Do you mean 'bananas' or 'banana'?
start_line: 2
end_line: 2
- path: README.md
annotation_level: warning
title: Spell Checker
message: Check your spelling for 'aples'
raw_details: Do you mean 'apples' or 'Naples'
start_line: 4
end_line: 4
images:
- alt: Super bananas
image_url: http://example.com/images/42
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/check-run'
examples:
default:
$ref: '#/components/examples/check-run'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: checks
subcategory: runs
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/check-suites/preferences:
patch:
summary: GitHub Update Repository Preferences for Check Suites
description: 'Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite).
You must have admin permissions in the repository to set preferences for check suites.'
tags:
- Update
operationId: updateRepositoryPreferencesForCheckSuites
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/checks/suites#update-repository-preferences-for-check-suites
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
auto_trigger_checks:
type: array
description: Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default.
items:
type: object
properties:
app_id:
type: integer
description: The `id` of the GitHub App.
setting:
type: boolean
description: Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.
default: true
required:
- app_id
- setting
examples:
default:
value:
auto_trigger_checks:
- app_id: 4
setting: false
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/check-suite-preference'
examples:
default:
$ref: '#/components/examples/check-suite-preference'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: checks
subcategory: suites
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/comments/{comment_id}:
patch:
summary: GitHub Update Commit Comment
description: 'Updates the contents of a specified commit comment.
This endpoint supports the following custom media types. For more information, see "[Media types](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/getting-started-with-the-rest-api#media-types)."
- **`application/vnd.github-commitcomment.raw+json`**: Returns the raw markdown body. Response will include `body`. This is the default if you do not pass any specific media type.
- **`application/vnd.github-commitcomment.text+json`**: Returns a text only representation of the markdown body. Response will include `body_text`.
- **`application/vnd.github-commitcomment.html+json`**: Returns HTML rendered from the body''s markdown. Response will include `body_html`.
- **`application/vnd.github-commitcomment.full+json`**: Returns raw, text, and HTML representations. Response will include `body`, `body_text`, and `body_html`.'
tags:
- Update
operationId: updateCommitComment
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/commits/comments#update-a-commit-comment
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/comment-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
body:
type: string
description: The contents of the comment
required:
- body
examples:
default:
value:
body: Nice change
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/commit-comment'
examples:
default:
$ref: '#/components/examples/commit-comment-2'
'404':
$ref: '#/components/responses/not_found'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: commits
subcategory: comments
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/contents/{path}:
put:
summary: GitHub Create or Update File Contents
description: 'Creates a new file or replaces an existing file in a repository.
**Note:** If you use this endpoint and the "[Delete a file](https://docs.github.com/enterprise-server@3.9/rest/repos/contents/#delete-a-file)" endpoint in parallel, the concurrent requests will conflict and you will receive errors. You must use these endpoints serially instead.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint. The `workflow` scope is also required in order to modify files in the `.github/workflows` directory.'
tags:
- Update
operationId: createOrUpdateFileContents
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/repos/contents#create-or-update-file-contents
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- name: path
description: path parameter
in: path
required: true
schema:
type: string
x-multi-segment: true
example: src/index.js
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
message:
type: string
description: The commit message.
content:
type: string
description: The new file content, using Base64 encoding.
sha:
type: string
description: '**Required if you are updating a file**. The blob SHA of the file being replaced.'
branch:
type: string
description: 'The branch name. Default: the repositorys default branch.'
committer:
type: object
description: 'The person that committed the file. Default: the authenticated user.'
properties:
name:
type: string
description: The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.
email:
type: string
description: The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.
date:
type: string
example: '"2013-01-05T13:13:22+05:00"'
required:
- name
- email
author:
type: object
description: 'The author of the file. Default: The `committer` or the authenticated user if you omit `committer`.'
properties:
name:
type: string
description: The name of the author or committer of the commit. You'll receive a `422` status code if `name` is omitted.
email:
type: string
description: The email of the author or committer of the commit. You'll receive a `422` status code if `email` is omitted.
date:
type: string
example: '"2013-01-15T17:13:22+05:00"'
required:
- name
- email
required:
- message
- content
examples:
example-for-creating-a-file:
summary: Example for creating a file
value:
message: my commit message
committer:
name: Monalisa Octocat
email: octocat@github.com
content: bXkgbmV3IGZpbGUgY29udGVudHM=
example-for-updating-a-file:
summary: Example for updating a file
value:
message: a new commit message
committer:
name: Monalisa Octocat
email: octocat@github.com
content: bXkgdXBkYXRlZCBmaWxlIGNvbnRlbnRz
sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/file-commit'
examples:
example-for-updating-a-file:
$ref: '#/components/examples/file-commit-example-for-updating-a-file'
'201':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/file-commit'
examples:
example-for-creating-a-file:
$ref: '#/components/examples/file-commit-example-for-creating-a-file'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/conflict'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: repos
subcategory: contents
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/environments/{environment_name}:
put:
summary: GitHub Create or Update an Environment
description: 'Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see "[Environments](/actions/reference/environments#environment-protection-rules)."
**Note:** To create or update name patterns that branches must match in order to deploy to this environment, see "[Deployment branch policies](/rest/deployments/branch-policies)."
**Note:** To create or update secrets for an environment, see "[GitHub Actions secrets](/rest/actions/secrets)."
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: createOrUpdateAnEnvironment
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/deployments/environments#create-or-update-an-environment
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/environment-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
wait_timer:
$ref: '#/components/schemas/wait-timer'
reviewers:
type: array
description: The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
items:
type: object
properties:
type:
$ref: '#/components/schemas/deployment-reviewer-type'
id:
type: integer
description: The id of the user or team who can review the deployment
example: 4532992
deployment_branch_policy:
$ref: '#/components/schemas/deployment-branch-policy-settings'
additionalProperties: false
examples:
default:
value:
wait_timer: 30
reviewers:
- type: User
id: 1
- type: Team
id: 1
deployment_branch_policy:
protected_branches: false
custom_branch_policies: true
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/environment'
examples:
default:
$ref: '#/components/examples/environment'
'422':
description: Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: deployments
subcategory: environments
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/environments/{environment_name}/deployment-branch-policies/{branch_policy_id}:
put:
summary: GitHub Update Deployment Branch Policy
description: 'Updates a deployment branch policy for an environment.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: updateDeploymentBranchPolicy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/deployments/branch-policies#update-a-deployment-branch-policy
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/environment-name'
- $ref: '#/components/parameters/branch-policy-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/deployment-branch-policy-name-pattern'
examples:
default:
value:
name: release/*
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/deployment-branch-policy'
examples:
default:
$ref: '#/components/examples/deployment-branch-policy-wildcard'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: deployments
subcategory: branch-policies
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/environments/{environment_name}/secrets/{secret_name}:
put:
summary: GitHub Create or Update an Environment Secret
description: 'Creates or updates an environment secret with an encrypted value. Encrypt your secret using
[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). For more information, see "[Encrypting secrets for the REST API](https://docs.github.com/enterprise-server@3.9/rest/guides/encrypting-secrets-for-the-rest-api)."
Authenticated users must have collaborator access to a repository to create, update, or read secrets.
OAuth tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: createOrUpdateAnEnvironmentSecret
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#create-or-update-an-environment-secret
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/environment-name'
- $ref: '#/components/parameters/secret-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
encrypted_value:
type: string
description: Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/enterprise-server@3.9/rest/actions/secrets#get-an-environment-public-key) endpoint.
pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$
key_id:
type: string
description: ID of the key you used to encrypt the secret.
required:
- encrypted_value
- key_id
examples:
default:
value:
encrypted_value: c2VjcmV0
key_id: 012345678912345678
responses:
'201':
description: Response when creating a secret
content:
application/json:
schema:
$ref: '#/components/schemas/empty-object_5'
examples:
default:
value: {}
'204':
description: Response when updating a secret
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: secrets
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/environments/{environment_name}/variables/{name}:
patch:
summary: GitHub Update an Environment Variable
description: 'Updates an environment variable that you can reference in a GitHub Actions workflow.
Authenticated users must have collaborator access to a repository to create, update, or read variables.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: updateAnEnvironmentVariable
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/actions/variables#update-an-environment-variable
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/variable-name'
- $ref: '#/components/parameters/environment-name'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the variable.
value:
type: string
description: The value of the variable.
examples:
default:
value:
name: USERNAME
value: octocat
responses:
'204':
description: Response
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: actions
subcategory: variables
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/git/refs/{ref}:
patch:
summary: GitHub Update Reference
description: Updates the provided reference to point to a new SHA. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
tags:
- Update
operationId: updateReference
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/git/refs#update-a-reference
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/git-ref-only'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
sha:
type: string
description: The SHA1 value to set this reference to
force:
type: boolean
description: Indicates whether to force the update or to make sure the update is a fast-forward update. Leaving this out or setting it to `false` will make sure you're not overwriting work.
default: false
required:
- sha
examples:
default:
value:
sha: aa218f56b14c9653891f9e74264a383fa43fefbd
force: true
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/git-ref'
examples:
default:
$ref: '#/components/examples/git-ref'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: git
subcategory: refs
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/labels/{name}:
patch:
summary: GitHub Update Label
description: Updates a label using the given label name.
tags:
- Update
operationId: updateLabel
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/labels#update-a-label
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- name: name
in: path
required: true
schema:
type: string
example: octocat
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
new_name:
type: string
description: The new name of the label. Emoji can be added to label names, using either native emoji or colon-style markup. For example, typing `:strawberry:` will render the emoji . For a full list of available emoji and codes, see "[Emoji cheat sheet](https://github.com/ikatyang/emoji-cheat-sheet)."
color:
type: string
description: The [hexadecimal color code](http://www.color-hex.com/) for the label, without the leading `#`.
description:
type: string
description: short description of the label. Must be 100 characters or fewer.
examples:
default:
value:
new_name: 'bug :bug:'
description: Small bug fix required
color: b01f26
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/label'
examples:
default:
$ref: '#/components/examples/label-2'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: labels
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/milestones/{milestone_number}:
patch:
summary: GitHub Update Milestone
description: The Update Milestone operation in the GitHub Repos API allows you to modify an existing milestone within a repository by sending a PATCH request to /repos/{owner}/{repo}/milestones/{milestone_number}. This endpoint enables you to update various milestone properties such as the title, state (open or closed), description, and due date. You must specify the repository owner, repository name, and milestone number in the URL path, while the fields you wish to update are provided in the request body as JSON. This operation requires appropriate authentication and write permissions to the repository, and it returns the updated milestone object upon successful execution, making it useful for project management tasks like adjusting deadlines, renaming milestones, or closing completed milestones.
tags:
- Update
operationId: updateMilestone
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/issues/milestones#update-a-milestone
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/milestone-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: The title of the milestone.
state:
type: string
description: The state of the milestone. Either `open` or `closed`.
enum:
- open
- closed
default: open
description:
type: string
description: description of the milestone.
due_on:
type: string
format: date-time
description: 'The milestone due date. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.'
examples:
default:
value:
title: v1.0
state: open
description: Tracking milestone for version 1.0
due_on: '2012-10-09T23:39:01Z'
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/milestone'
examples:
default:
$ref: '#/components/examples/milestone'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: issues
subcategory: milestones
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/pages:
put:
summary: GitHub Update Information About Github Enterprise Server Pages Site
description: 'Updates information for a GitHub Enterprise Server Pages site. For more information, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages).
The authenticated user must be a repository administrator, maintainer, or have the ''manage GitHub Pages settings'' permission.
OAuth app tokens and personal access tokens (classic) need the `repo` scope to use this endpoint.'
tags:
- Update
operationId: updateInformationAboutGithubEnterpriseServerPagesSite
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/pages/pages#update-information-about-a-apiname-pages-site
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
cname:
type: string
description: Specify a custom domain for the repository. Sending a `null` value will remove the custom domain. For more about custom domains, see "[Using a custom domain with GitHub Pages](https://docs.github.com/enterprise-server@3.9/articles/using-a-custom-domain-with-github-pages/)."
https_enforced:
type: boolean
description: Specify whether HTTPS should be enforced for the repository.
build_type:
type: string
description: The process by which the GitHub Pages site will be built. `workflow` means that the site is built by a custom GitHub Actions workflow. `legacy` means that the site is built by GitHub when changes are pushed to a specific branch.
enum:
- legacy
- workflow
source:
anyOf:
- type: string
description: Update the source for the repository. Must include the branch name, and may optionally specify the subdirectory `/docs`. Possible values are `"gh-pages"`, `"master"`, and `"master /docs"`.
enum:
- gh-pages
- master
- master /docs
- type: object
description: Update the source for the repository. Must include the branch name and path.
properties:
branch:
type: string
description: The repository branch used to publish your site's source files.
path:
type: string
description: The repository directory that includes the source files for the Pages site. Allowed paths are `/` or `/docs`.
enum:
- /
- /docs
required:
- branch
- path
anyOf:
- required:
- build_type
- required:
- source
- required:
- cname
- required:
- public
- required:
- https_enforced
examples:
default:
value:
cname: octocatblog.com
source:
branch: main
path: /
responses:
'204':
description: Response
'400':
$ref: '#/components/responses/bad_request'
'409':
$ref: '#/components/responses/conflict'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: pages
subcategory: pages
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/releases/assets/{asset_id}:
patch:
summary: GitHub Update Release Asset
description: Users with push access to the repository can edit a release asset.
tags:
- Update
operationId: updateReleaseAsset
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/releases/assets#update-a-release-asset
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/asset-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The file name of the asset.
label:
type: string
description: An alternate short description of the asset. Used in place of the filename.
state:
type: string
example: '"uploaded"'
examples:
default:
value:
name: foo-1.0.0-osx.zip
label: Mac binary
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/release-asset'
examples:
default:
$ref: '#/components/examples/release-asset'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: releases
subcategory: assets
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/releases/{release_id}:
patch:
summary: GitHub Update Release
description: Users with push access to the repository can edit a release.
tags:
- Update
operationId: updateRelease
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/releases/releases#update-a-release
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/release-id'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
tag_name:
type: string
description: The name of the tag.
target_commitish:
type: string
description: 'Specifies the commitish value that determines where the Git tag is created from. Can be any branch or commit SHA. Unused if the Git tag already exists. Default: the repository''s default branch.'
name:
type: string
description: The name of the release.
body:
type: string
description: Text describing the contents of the tag.
draft:
type: boolean
description: '`true` makes the release a draft, and `false` publishes the release.'
prerelease:
type: boolean
description: '`true` to identify the release as a prerelease, `false` to identify the release as a full release.'
make_latest:
type: string
description: Specifies whether this release should be set as the latest release for the repository. Drafts and prereleases cannot be set as latest. Defaults to `true` for newly published releases. `legacy` specifies that the latest release should be determined based on the release creation date and higher semantic version.
enum:
- 'true'
- 'false'
- legacy
default: 'true'
examples:
default:
value:
tag_name: v1.0.0
target_commitish: master
name: v1.0.0
body: Description of the release
draft: false
prerelease: false
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/release'
examples:
default:
$ref: '#/components/examples/release'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: releases
subcategory: releases
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/repos/{owner}/{repo}/secret-scanning/alerts/{alert_number}:
patch:
summary: GitHub Update Secret Scanning Alert
description: 'Updates the status of a secret scanning alert in an eligible repository.
The authenticated user must be an administrator for the repository or for the organization that owns the repository to use this endpoint.
OAuth app tokens and personal access tokens (classic) need the `repo` or `security_events` scope to use this endpoint. If this endpoint is only used with public repositories, the token can use the `public_repo` scope instead.'
operationId: updateSecretScanningAlert
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/secret-scanning/secret-scanning#update-a-secret-scanning-alert
parameters:
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
- $ref: '#/components/parameters/alert-number'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
state:
$ref: '#/components/schemas/secret-scanning-alert-state'
resolution:
$ref: '#/components/schemas/secret-scanning-alert-resolution'
resolution_comment:
$ref: '#/components/schemas/secret-scanning-alert-resolution-comment'
required:
- state
examples:
default:
value:
state: resolved
resolution: false_positive
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/secret-scanning-alert'
examples:
default:
$ref: '#/components/examples/secret-scanning-alert-resolved'
'400':
description: Bad request, resolution comment is invalid or the resolution was not changed.
'404':
description: Repository is public, or secret scanning is disabled for the repository, or the resource is not found
'422':
description: State does not match the resolution or resolution comment
'503':
$ref: '#/components/responses/service_unavailable'
x-github:
enabledForGitHubApps: true
githubCloudOnly: false
category: secret-scanning
subcategory: secret-scanning
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/scim/v2/Groups/{scim_group_id}:
patch:
summary: GitHub Update an Attribute for Scim Enterprise Group
description: '**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.
Update a provisioned group’s individual attributes.
To change a group’s values, you must provide a specific Operations JSON format that contains at least one of the add, remove, or replace operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2). Update can also be used to add group memberships.
Group memberships can be sent one at a time or in batches for faster performance. **Note**: The memberships are referenced through a local user `id`, and the user will need to be created before they are referenced here.'
operationId: updateAnAttributeForScimEnterpriseGroup
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-group
parameters:
- $ref: '#/components/parameters/scim-group-id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/patch-schema'
examples:
updateGroup:
summary: Update Group
value:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
- op: replace
path: displayName
value: Employees
addMembers:
summary: Add Members
value:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
- op: add
path: members
value:
- value: 879db59-3bdf-4490-ad68-ab880a2694745
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
responses:
'200':
description: Success, group was updated
content:
application/scim+json:
schema:
$ref: '#/components/schemas/scim-enterprise-group-response'
examples:
updateGroup:
$ref: '#/components/examples/scim-enterprise-group'
addMembers:
$ref: '#/components/examples/scim-enterprise-group'
'204':
description: Response
'400':
$ref: '#/components/responses/scim_bad_request'
'401':
$ref: '#/components/responses/authorization_failure'
'403':
$ref: '#/components/responses/permission_denied'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/duplicate_record_detected'
'429':
$ref: '#/components/responses/scim_too_many_requests'
'500':
$ref: '#/components/responses/scim_internal_error'
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
category: enterprise-admin
subcategory: scim
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/scim/v2/Users/{scim_user_id}:
patch:
summary: GitHub Update an Attribute for Scim Enterprise User
description: "**Note:** The SCIM API endpoints for enterprise accounts are currently in *private* beta and are subject to change.\n\nUpdate a provisioned user's individual attributes.\n\nTo change a user's values, you must provide a specific `Operations` JSON format that contains at least one of the `add`, `remove`, or `replace` operations. For examples and more information on the SCIM operations format, see the [SCIM specification](https://tools.ietf.org/html/rfc7644#section-3.5.2).\n\n**Note:** Complicated SCIM `path` selectors that include filters are not supported. For example, a `path` selector defined as `\"path\": \"emails[type eq \\\"work\\\"]\"` will not work.\n\n**Warning:** Setting `active: false` will suspend a user and obfuscate the user handle and user email. Since the implementation is a generic SCIM implementation and does not differentiate yet between different IdP providers, for Okta, the user GDPR data will not be purged and the credentials will not be removed.\n```\n{\n \"Operations\":[{\n \"op\":\"replace\",\n \"value\":{\n \"active\":false\n }\n }]\n}\n```"
operationId: updateAnAttributeForScimEnterpriseUser
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/scim#update-an-attribute-for-a-scim-enterprise-user
parameters:
- $ref: '#/components/parameters/scim-user-id'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/patch-schema'
examples:
userMultiValuedProperties:
summary: Multi Valued Property
value:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
- op: replace
path: emails[type eq 'work'].value
value: updatedEmail@microsoft.com
- op: replace
path: name.familyName
value: updatedFamilyName
userSingleValuedProperties:
summary: Single Valued Property
value:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
- op: replace
path: userName
value: 5b50642d-79fc-4410-9e90-4c077cdd1a59@testuser.com
- op: replace
path: displayName
value: Monalisa Octocat
disableUser:
summary: Disable User
value:
schemas:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
Operations:
- op: replace
path: active
value: false
responses:
'200':
description: Success, user was updated
content:
application/scim+json:
schema:
$ref: '#/components/schemas/scim-enterprise-user-response'
examples:
userMultiValuedProperties:
$ref: '#/components/examples/scim-enterprise-user'
userSingleValuedProperties:
$ref: '#/components/examples/scim-enterprise-user'
disableUser:
$ref: '#/components/examples/scim-enterprise-user'
'400':
$ref: '#/components/responses/scim_bad_request'
'401':
$ref: '#/components/responses/authorization_failure'
'403':
$ref: '#/components/responses/permission_denied'
'404':
$ref: '#/components/responses/not_found'
'409':
$ref: '#/components/responses/duplicate_record_detected'
'429':
$ref: '#/components/responses/scim_too_many_requests'
'500':
$ref: '#/components/responses/scim_internal_error'
x-github:
enabledForGitHubApps: true
githubCloudOnly: true
category: enterprise-admin
subcategory: scim
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/ldap/teams/{team_id}/mapping:
patch:
summary: GitHub Update Ldap Mapping for Team
description: Updates the [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team. [LDAP synchronization](https://docs.github.com/enterprise-server@3.9/admin/identity-and-access-management/using-ldap-for-enterprise-iam/using-ldap#enabling-ldap-sync) must be enabled to map LDAP entries to a team. Use the [Create a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams/#create-a-team) endpoint to create a team with LDAP mapping.
operationId: updateLdapMappingForTeam
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-team
parameters:
- $ref: '#/components/parameters/team-id'
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/ldap-mapping-team'
examples:
default:
$ref: '#/components/examples/ldap-mapping-team'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ldap_dn:
type: string
description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.
required:
- ldap_dn
examples:
default:
value:
ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: enterprise-admin
subcategory: ldap
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/teams/{team_id}:
patch:
summary: GitHub Update Team (legacy)
description: '**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a team](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team) endpoint.
To edit a team, the authenticated user must either be an organization owner or a team maintainer.
**Note:** With nested teams, the `privacy` for parent teams cannot be `secret`.'
tags:
- Update
operationId: updateTeamLegacy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#update-a-team-legacy
parameters:
- $ref: '#/components/parameters/team-id'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
name:
type: string
description: The name of the team.
description:
type: string
description: The description of the team.
privacy:
type: string
description: "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. The options are: \n**For a non-nested team:** \n * `secret` - only visible to organization owners and members of this team. \n * `closed` - visible to all members of this organization. \n**For a parent or child team:** \n * `closed` - visible to all members of this organization."
enum:
- secret
- closed
permission:
type: string
description: '**Deprecated**. The permission that new repositories will be added to the team with when none is specified.'
enum:
- pull
- push
- admin
default: pull
parent_team_id:
type: integer
description: The ID of a team to set as the parent team.
nullable: true
required:
- name
examples:
default:
value:
name: new team name
description: new team description
privacy: closed
responses:
'200':
description: Response when the updated information already exists
content:
application/json:
schema:
$ref: '#/components/schemas/team-full'
examples:
default:
$ref: '#/components/examples/team-full'
'201':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-full'
examples:
default:
$ref: '#/components/examples/team-full'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
category: teams
subcategory: teams
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/teams/{team_id}/discussions/{discussion_number}:
patch:
summary: GitHub Update Discussion (legacy)
description: '**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion](https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion) endpoint.
Edits the title and body text of a discussion post. Only the parameters you provide are updated.
OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.'
tags:
- Update
operationId: updateDiscussionLegacy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/discussions#update-a-discussion-legacy
parameters:
- $ref: '#/components/parameters/team-id'
- $ref: '#/components/parameters/discussion-number'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
title:
type: string
description: The discussion post's title.
body:
type: string
description: The discussion post's body text.
examples:
default:
value:
title: Welcome to our first team post
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-discussion'
examples:
default:
$ref: '#/components/examples/team-discussion-2'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
category: teams
subcategory: discussions
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/teams/{team_id}/discussions/{discussion_number}/comments/{comment_number}:
patch:
summary: GitHub Update Discussion Comment (legacy)
description: '**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Update a discussion comment](https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment) endpoint.
Edits the body text of a discussion comment.
OAuth app tokens and personal access tokens (classic) need the `write:discussion` scope to use this endpoint.'
tags:
- Update
operationId: updateDiscussionCommentLegacy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/discussion-comments#update-a-discussion-comment-legacy
parameters:
- $ref: '#/components/parameters/team-id'
- $ref: '#/components/parameters/discussion-number'
- $ref: '#/components/parameters/comment-number'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
body:
type: string
description: The discussion comment's body text.
required:
- body
examples:
default:
value:
body: Do you like pineapples?
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-discussion-comment'
examples:
default:
$ref: '#/components/examples/team-discussion-comment-2'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
category: teams
subcategory: discussion-comments
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/teams/{team_id}/memberships/{username}:
put:
summary: GitHub Add or Update Team Membership for User (legacy)
description: '**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new [Add or update team membership for a user](https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user) endpoint.
Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub''s products](https://docs.github.com/enterprise-server@3.9/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.
If the user is already a member of the team''s organization, this endpoint will add the user to the team. To add a membership between an organization member and a team, the authenticated user must be an organization owner or a team maintainer.
**Note:** When you have team synchronization set up for a team with your organization''s identity provider (IdP), you will see an error if you attempt to use the API for making changes to the team''s membership. If you have access to manage group membership in your IdP, you can manage GitHub Enterprise Server team membership through your identity provider, which automatically adds and removes team members in an organization. For more information, see "[Synchronizing teams between your identity provider and GitHub Enterprise Server](https://docs.github.com/enterprise-server@3.9/articles/synchronizing-teams-between-your-identity-provider-and-github/)."
If the user is unaffiliated with the team''s organization, this endpoint will send an invitation to the user via email. This newly-created membership will be in the "pending" state until the user accepts the invitation, at which point the membership will transition to the "active" state and the user will be added as a member of the team. To add a membership between an unaffiliated user and a team, the authenticated user must be an organization owner.
If the user is already a member of the team, this endpoint will update the role of the team member''s role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.'
tags:
- Update
operationId: addOrUpdateTeamMembershipForUserLegacy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/members#add-or-update-team-membership-for-a-user-legacy
parameters:
- $ref: '#/components/parameters/team-id'
- $ref: '#/components/parameters/username'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
role:
type: string
description: The role that this user should have in the team.
enum:
- member
- maintainer
default: member
examples:
default:
summary: Assign the member role for a user in a team
value:
role: member
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/team-membership'
examples:
response-if-users-membership-with-team-is-now-pending:
$ref: '#/components/examples/team-membership-response-if-users-membership-with-team-is-now-pending'
'403':
description: Forbidden if team synchronization is set up
'404':
$ref: '#/components/responses/not_found'
'422':
description: Unprocessable Entity if you attempt to add an organization to a team
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
category: teams
subcategory: members
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/teams/{team_id}/repos/{owner}/{repo}:
put:
summary: GitHub Add or Update Team Repository Permissions (legacy)
description: '**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Teams API. We recommend migrating your existing code to use the new "[Add or update team repository permissions](https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions)" endpoint.
To add a repository to a team or update the team''s permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization.
Note that, if you choose not to pass any parameters, you''ll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see "[HTTP method](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-rest-api#http-method)."'
tags:
- Update
operationId: addOrUpdateTeamRepositoryPermissionsLegacy
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#add-or-update-team-repository-permissions-legacy
parameters:
- $ref: '#/components/parameters/team-id'
- $ref: '#/components/parameters/owner'
- $ref: '#/components/parameters/repo'
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
permission:
type: string
description: The permission to grant the team on this repository. If no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.
enum:
- pull
- push
- admin
examples:
default:
summary: Example of setting permission to pull
value:
permission: push
responses:
'204':
description: Response
'403':
$ref: '#/components/responses/forbidden'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
removalDate: '2021-02-01'
deprecationDate: '2020-01-21'
category: teams
subcategory: teams
deprecated: true
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/ldap/users/{username}/mapping:
patch:
summary: GitHub Update Ldap Mapping for User
description: Updates the LDAP mapping for an authenticated user by modifying the distinguished name (DN) that maps a specific GitHub Enterprise Server user account to an LDAP directory entry. This endpoint allows administrators to change or correct the LDAP authentication mapping for a user, which is useful when LDAP directory structure changes or when a user's DN needs to be updated without recreating the GitHub account. The operation requires admin privileges and updates the synchronization between the GitHub user and their corresponding LDAP identity, ensuring continued authentication and authorization through the LDAP directory.
operationId: updateLdapMappingForUser
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/ldap#update-ldap-mapping-for-a-user
parameters:
- $ref: '#/components/parameters/username'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/ldap-mapping-user'
examples:
default:
$ref: '#/components/examples/ldap-mapping-user'
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ldap_dn:
type: string
description: The [distinguished name](https://www.ldap.com/ldap-dns-and-rdns) (DN) of the LDAP entry to map to a team.
required:
- ldap_dn
examples:
default:
value:
ldap_dn: uid=asdf,ou=users,dc=github,dc=com
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: enterprise-admin
subcategory: ldap
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/admin/users/{username}:
patch:
summary: GitHub Update the Username for User
description: The PATCH operation on the /admin/users/{username} endpoint allows administrators to update the username for a specific GitHub user account. This API call requires admin privileges and targets a specific user by their current username in the URL path. The operation modifies the user's login identifier while preserving their account history, repositories, and associated data. This is typically used for account maintenance purposes such as correcting usernames, handling name changes, or resolving conflicts, and requires appropriate authentication and authorization to prevent unauthorized modifications to user accounts.
operationId: updateTheUsernameForUser
tags:
- Update
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/enterprise-admin/users#update-the-username-for-a-user
parameters:
- $ref: '#/components/parameters/username'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
responses:
'202':
description: Response
content:
application/json:
schema:
type: object
properties:
message:
type: string
url:
type: string
examples:
default:
value:
message: Job queued to rename user. It may take a few minutes to complete.
url: https://api.github.com/user/1
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
login:
type: string
description: The user's new username.
required:
- login
examples:
default:
value:
login: thenewmonalisa
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: enterprise-admin
subcategory: users
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/user:
patch:
summary: GitHub Update the Authenticated User
description: '**Note:** If your email is set to private and you send an `email` parameter as part of this request to update your profile, your privacy settings are still enforced: the email address will not be displayed on your public profile or via the API.'
tags:
- Update
operationId: updateTheAuthenticatedUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/users/users#update-the-authenticated-user
parameters:
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: false
content:
application/json:
schema:
type: object
properties:
name:
description: The new name of the user.
type: string
example: Omar Jahandar
email:
description: The publicly visible email address of the user.
type: string
example: omar@example.com
blog:
description: The new blog URL of the user.
type: string
example: blog.example.com
twitter_username:
description: The new Twitter username of the user.
type: string
example: therealomarj
nullable: true
company:
description: The new company of the user.
type: string
example: Acme corporation
location:
description: The new location of the user.
type: string
example: Berlin, Germany
hireable:
description: The new hiring availability of the user.
type: boolean
bio:
description: The new short biography of the user.
type: string
examples:
default:
summary: Example of updating blog and name
value:
blog: https://github.com/blog
name: monalisa octocat
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/private-user'
examples:
default:
$ref: '#/components/examples/private-user'
'304':
$ref: '#/components/responses/not_modified'
'401':
$ref: '#/components/responses/requires_authentication'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: false
category: users
subcategory: users
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
/user/memberships/orgs/{org}:
patch:
summary: GitHub Update an Organization Membership for the Authenticated User
description: Converts the authenticated user to an active member of the organization, if that user has a pending invitation from the organization.
tags:
- Update
operationId: updateAnOrganizationMembershipForTheAuthenticatedUser
externalDocs:
description: API method documentation
url: https://docs.github.com/enterprise-server@3.9/rest/orgs/members#update-an-organization-membership-for-the-authenticated-user
parameters:
- $ref: '#/components/parameters/org'
- in: header
name: Authorization
schema:
type: string
example: example_value
- in: header
name: X-GitHub-Api-Version
schema:
type: string
default: '2022-11-28'
example: example_value
- in: header
name: Accept
schema:
type: string
default: application/vnd.github+json
example: example_value
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
state:
type: string
description: The state that the membership should be in. Only `"active"` will be accepted.
enum:
- active
required:
- state
examples:
default:
value:
state: active
responses:
'200':
description: Response
content:
application/json:
schema:
$ref: '#/components/schemas/org-membership'
examples:
default:
$ref: '#/components/examples/org-membership-2'
'403':
$ref: '#/components/responses/forbidden'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/validation_failed'
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: orgs
subcategory: members
security:
- bearerHttpAuthentication: []
x-microcks-operation:
delay: 0
dispatcher: FALLBACK
components:
schemas:
nullable-simple-user:
title: Simple User
description: A GitHub user.
type: object
properties:
name:
nullable: true
type: string
example: octocat
email:
nullable: true
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
nullable: true
integration:
title: GitHub app
description: 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 come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
type: object
properties:
id:
description: Unique identifier of the GitHub app
example: 37
type: integer
slug:
description: The slug name of the GitHub app
example: probot-owners
type: string
node_id:
type: string
example: MDExOkludGVncmF0aW9uMQ==
owner:
$ref: '#/components/schemas/nullable-simple-user_2'
name:
description: The name of the GitHub app
example: Probot Owners
type: string
description:
type: string
example: The description of the app.
external_url:
type: string
format: uri
example: https://example.com
html_url:
type: string
format: uri
example: https://github.com/apps/super-ci
created_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
updated_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
permissions:
description: The set of permissions for the GitHub app
type: object
properties:
issues:
type: string
checks:
type: string
metadata:
type: string
contents:
type: string
deployments:
type: string
additionalProperties:
type: string
example:
issues: read
deployments: write
events:
description: The list of events for the GitHub app
example:
- label
- deployment
type: array
items:
type: string
installations_count:
description: The number of installations associated with the GitHub app
example: 5
type: integer
client_id:
type: string
example: '"Iv1.25b5d1e65ffc4022"'
client_secret:
type: string
example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"'
webhook_secret:
type: string
example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"'
pem:
type: string
example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"'
required:
- id
- node_id
- owner
- name
- description
- external_url
- html_url
- created_at
- updated_at
- permissions
- events
alert-html-url:
type: string
description: The GitHub URL of the alert resource.
format: uri
readOnly: true
protected-branch-pull-request-review:
title: Protected Branch Pull Request Review
description: Protected Branch Pull Request Review
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions
dismissal_restrictions:
type: object
properties:
users:
description: The list of users with review dismissal access.
type: array
items:
$ref: '#/components/schemas/simple-user_2'
teams:
description: The list of teams with review dismissal access.
type: array
items:
$ref: '#/components/schemas/team'
apps:
description: The list of apps with review dismissal access.
type: array
items:
$ref: '#/components/schemas/integration'
url:
type: string
example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions"'
users_url:
type: string
example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/users"'
teams_url:
type: string
example: '"https://api.github.com/repos/the-org/an-org-repo/branches/master/protection/dismissal_restrictions/teams"'
bypass_pull_request_allowances:
type: object
description: Allow specific users, teams, or apps to bypass pull request requirements.
properties:
users:
description: The list of users allowed to bypass pull request requirements.
type: array
items:
$ref: '#/components/schemas/simple-user_2'
teams:
description: The list of teams allowed to bypass pull request requirements.
type: array
items:
$ref: '#/components/schemas/team'
apps:
description: The list of apps allowed to bypass pull request requirements.
type: array
items:
$ref: '#/components/schemas/integration'
dismiss_stale_reviews:
type: boolean
example: true
require_code_owner_reviews:
type: boolean
example: true
required_approving_review_count:
type: integer
minimum: 0
maximum: 6
example: 2
require_last_push_approval:
description: Whether the most recent push must be approved by someone other than the person who pushed it.
type: boolean
example: true
default: false
required:
- dismiss_stale_reviews
- require_code_owner_reviews
repository-pre-receive-hook:
type: object
properties:
id:
type: integer
example: 42
name:
type: string
example: octocat
enforcement:
type: string
example: example_value
configuration_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
gist-history:
title: Gist History
description: Gist History
type: object
properties:
user:
$ref: '#/components/schemas/nullable-simple-user'
version:
type: string
example: example_value
committed_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
change_status:
type: object
properties:
total:
type: integer
additions:
type: integer
deletions:
type: integer
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
code-scanning-analysis-tool-version:
type: string
description: The version of the tool used to generate the code scanning analysis.
repository:
title: Repository
description: A repository on GitHub.
type: object
properties:
id:
description: Unique identifier of the repository
example: 42
type: integer
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
description: The name of the repository.
type: string
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
$ref: '#/components/schemas/nullable-license-simple'
forks:
type: integer
example: 42
permissions:
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
required:
- admin
- pull
- push
owner:
$ref: '#/components/schemas/simple-user'
private:
description: Whether the repository is private or public.
default: false
type: boolean
example: true
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
nullable: true
fork:
type: boolean
example: true
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example: git@github.com:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
nullable: true
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
nullable: true
language:
type: string
nullable: true
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
description: The default branch of the repository.
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
description: Whether this repository acts as a template that can be used to generate new repositories.
default: false
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
description: Whether issues are enabled.
default: true
type: boolean
example: true
has_projects:
description: Whether projects are enabled.
default: true
type: boolean
example: true
has_wiki:
description: Whether the wiki is enabled.
default: true
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
description: Whether downloads are enabled.
default: true
type: boolean
example: true
deprecated: true
has_discussions:
description: Whether discussions are enabled.
default: false
type: boolean
example: true
archived:
description: Whether the repository is archived.
default: false
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
default: public
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43Z'
nullable: true
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
nullable: true
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43Z'
nullable: true
allow_rebase_merge:
description: Whether to allow rebase merges for pull requests.
default: true
type: boolean
example: true
temp_clone_token:
type: string
allow_squash_merge:
description: Whether to allow squash merges for pull requests.
default: true
type: boolean
example: true
allow_auto_merge:
description: Whether to allow Auto-merge to be used on pull requests.
default: false
type: boolean
example: false
delete_branch_on_merge:
description: Whether to delete head branches when pull requests are merged
default: false
type: boolean
example: false
allow_update_branch:
description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
default: false
type: boolean
example: false
use_squash_pr_title_as_default:
type: boolean
description: Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: 'The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request''s title.
- `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).'
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: 'The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request''s body.
- `COMMIT_MESSAGES` - default to the branch''s commit messages.
- `BLANK` - default to a blank commit message.'
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: 'The default value for a merge commit title.
- `PR_TITLE` - default to the pull request''s title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).'
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: 'The default value for a merge commit message.
- `PR_TITLE` - default to the pull request''s title.
- `PR_BODY` - default to the pull request''s body.
- `BLANK` - default to a blank commit message.'
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
type: boolean
example: true
allow_forking:
description: Whether to allow forking this repo
type: boolean
web_commit_signoff_required:
description: Whether to require contributors to sign off on web-based commits
default: false
type: boolean
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_downloads
- has_issues
- has_projects
- has_wiki
- has_pages
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
code-scanning-default-setup-update:
description: Configuration for code scanning default setup.
type: object
properties:
state:
description: The desired state of code scanning default setup.
type: string
enum:
- configured
- not-configured
example: configured
query_suite:
description: CodeQL query suite to be used.
type: string
enum:
- default
- extended
example: default
additionalProperties: true
required:
- state
team-discussion-comment:
title: Team Discussion Comment
description: A reply to a discussion within a team.
type: object
properties:
author:
$ref: '#/components/schemas/nullable-simple-user'
body:
description: The main text of the comment.
example: I agree with this suggestion.
type: string
body_html:
type: string
example:
Do you like apples?
body_version:
description: The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
created_at:
type: string
format: date-time
example: '2018-01-15T23:53:58Z'
last_edited_at:
type: string
format: date-time
nullable: true
example: '2026-04-17T12:00:00Z'
discussion_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2403582/discussions/1
html_url:
type: string
format: uri
example: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
node_id:
type: string
example: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
number:
description: The unique sequence number of a team discussion comment.
example: 42
type: integer
updated_at:
type: string
format: date-time
example: '2018-01-15T23:53:58Z'
url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1
reactions:
$ref: '#/components/schemas/reaction-rollup'
required:
- author
- body
- body_html
- body_version
- created_at
- last_edited_at
- discussion_url
- html_url
- node_id
- number
- updated_at
- url
scim-enterprise-group-response:
allOf:
- $ref: '#/components/schemas/group-response'
- type: object
properties:
id:
type: string
description: The internally generated id for the group object.
example: 7fce0092-d52e-4f76-b727-3955bd72c939
members:
type: array
items:
type: object
properties:
value:
type: string
$ref:
type: string
display:
type: string
description: The security group members.
example:
- value: 879db59-3bdf-4490-ad68-ab880a2694745
$+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745
displayName: User 1
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
$+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
meta:
$ref: '#/components/schemas/meta'
alert-updated-at:
type: string
description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
alert-fixed-at:
type: string
description: 'The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
nullable-milestone:
title: Milestone
description: A collection of related issues and pull requests.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id:
type: integer
example: 1002604
node_id:
type: string
example: MDk6TWlsZXN0b25lMTAwMjYwNA==
number:
description: The number of the milestone.
type: integer
example: 42
state:
description: The state of the milestone.
example: open
type: string
enum:
- open
- closed
default: open
title:
description: The title of the milestone.
example: v1.0
type: string
description:
type: string
example: Tracking milestone for version 1.0
nullable: true
creator:
$ref: '#/components/schemas/nullable-simple-user'
open_issues:
type: integer
example: 4
closed_issues:
type: integer
example: 8
created_at:
type: string
format: date-time
example: '2011-04-10T20:09:31Z'
updated_at:
type: string
format: date-time
example: '2014-03-03T18:58:10Z'
closed_at:
type: string
format: date-time
example: '2013-02-12T13:22:01Z'
nullable: true
due_on:
type: string
format: date-time
example: '2012-10-09T23:39:01Z'
nullable: true
required:
- closed_issues
- creator
- description
- due_on
- closed_at
- id
- node_id
- labels_url
- html_url
- number
- open_issues
- state
- title
- url
- created_at
- updated_at
nullable: true
webhook-config-secret:
type: string
description: 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-server@3.9/webhooks/event-payloads/#delivery-headers).
example: '"********"'
external-group:
title: ExternalGroup
description: Information about an external group's usage and its members
type: object
required:
- group_id
- group_name
- teams
- members
properties:
group_id:
description: The internal ID of the group
example: 1
type: integer
group_name:
description: The display name for the group
example: group-azuread-test
type: string
updated_at:
description: The date when the group was last updated_at
example: 2021-01-03 22:27:15:000 -700
type: string
teams:
description: An array of teams linked to this group
example:
- team_id: 1
team_name: team-test
- team_id: 2
team_name: team-test2
type: array
items:
type: object
required:
- team_id
- team_name
properties:
team_id:
description: The id for a team
example: 1
type: integer
team_name:
description: The name of the team
example: team-test
type: string
members:
description: An array of external members linked to this group
example:
- member_id: 1
member_login: mona-lisa_eocsaxrs
member_name: Mona Lisa
member_email: mona_lisa@github.com
- member_id: 2
member_login: octo-lisa_eocsaxrs
member_name: Octo Lisa
member_email: octo_lisa@github.com
type: array
items:
type: object
required:
- member_id
- member_login
- member_name
- member_email
properties:
member_id:
description: The internal user ID of the identity
example: 1
type: integer
member_login:
description: The handle/login for the user
example: mona-lisa_eocsaxrs
type: string
member_name:
description: The user display name/profile name
example: Mona Lisa
type: string
member_email:
description: An email attached to a user
example: mona_lisa@github.com
type: string
dependabot-alert-security-advisory:
type: object
description: Details for the GitHub Security Advisory.
readOnly: true
properties:
ghsa_id:
type: string
description: The unique GitHub Security Advisory ID assigned to the advisory.
readOnly: true
example: '12345678'
cve_id:
type: string
description: The unique CVE ID assigned to the advisory.
readOnly: true
example: '12345678'
summary:
type: string
description: short, plain text summary of the advisory.
readOnly: true
maxLength: 1024
example: example_value
description:
type: string
description: long-form Markdown-supported description of the advisory.
readOnly: true
example: This is an example repository
vulnerabilities:
type: array
description: Vulnerable version range information for the advisory.
readOnly: true
items:
$ref: '#/components/schemas/dependabot-alert-security-vulnerability'
severity:
type: string
description: The severity of the advisory.
readOnly: true
enum:
- low
- medium
- high
- critical
example: low
cvss:
type: object
description: Details for the advisory pertaining to the Common Vulnerability Scoring System.
readOnly: true
properties:
score:
type: number
description: The overall CVSS score of the advisory.
minimum: 0
maximum: 10
readOnly: true
vector_string:
type: string
description: The full CVSS vector string for the advisory.
readOnly: true
required:
- score
- vector_string
additionalProperties: false
cwes:
type: array
description: Details for the advisory pertaining to Common Weakness Enumeration.
readOnly: true
items:
type: object
description: CWE weakness assigned to the advisory.
readOnly: true
properties:
cwe_id:
type: string
description: The unique CWE ID.
readOnly: true
name:
type: string
description: The short, plain text name of the CWE.
readOnly: true
required:
- cwe_id
- name
additionalProperties: false
identifiers:
type: array
description: Values that identify this advisory among security information sources.
readOnly: true
items:
type: object
description: An advisory identifier.
readOnly: true
properties:
type:
type: string
description: The type of advisory identifier.
readOnly: true
enum:
- CVE
- GHSA
value:
type: string
description: The value of the advisory identifer.
readOnly: true
required:
- value
- type
additionalProperties: false
references:
type: array
description: Links to additional advisory information.
readOnly: true
items:
type: object
description: link to additional advisory information.
readOnly: true
properties:
url:
type: string
description: The URL of the reference.
format: uri
readOnly: true
required:
- url
additionalProperties: false
published_at:
type: string
description: 'The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
example: '2026-04-17T12:00:00Z'
updated_at:
type: string
description: 'The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
example: '2026-04-17T12:00:00Z'
withdrawn_at:
type: string
description: 'The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
example: '2026-04-17T12:00:00Z'
required:
- ghsa_id
- cve_id
- summary
- description
- vulnerabilities
- severity
- cvss
- cwes
- identifiers
- references
- published_at
- updated_at
- withdrawn_at
additionalProperties: false
code-of-conduct-simple:
title: Code Of Conduct Simple
description: Code of Conduct Simple
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/github/docs/community/code_of_conduct
key:
type: string
example: citizen_code_of_conduct
name:
type: string
example: Citizen Code of Conduct
html_url:
type: string
format: uri
example: https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md
required:
- url
- key
- name
- html_url
full-repository:
title: Full Repository
description: Full Repository
type: object
properties:
id:
type: integer
format: int64
example: 1296269
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
type: string
example: Hello-World
full_name:
type: string
example: octocat/Hello-World
owner:
$ref: '#/components/schemas/simple-user_6'
private:
type: boolean
example: true
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
fork:
type: boolean
example: true
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example: git@github.com:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
language:
type: string
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
type: boolean
example: true
topics:
type: array
items:
type: string
example:
- octocat
- atom
- electron
- API
has_issues:
type: boolean
example: true
has_projects:
type: boolean
example: true
has_wiki:
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
type: boolean
example: true
has_discussions:
type: boolean
example: true
archived:
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
type: string
example: public
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43Z'
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43Z'
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
required:
- admin
- pull
- push
allow_rebase_merge:
type: boolean
example: true
template_repository:
$ref: '#/components/schemas/nullable-repository'
temp_clone_token:
type: string
allow_squash_merge:
type: boolean
example: true
allow_auto_merge:
type: boolean
example: false
delete_branch_on_merge:
type: boolean
example: false
allow_merge_commit:
type: boolean
example: true
allow_update_branch:
type: boolean
example: true
use_squash_pr_title_as_default:
type: boolean
example: false
squash_merge_commit_title:
type: string
example: PR_TITLE
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: 'The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request''s title.
- `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).'
squash_merge_commit_message:
type: string
example: PR_BODY
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: 'The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request''s body.
- `COMMIT_MESSAGES` - default to the branch''s commit messages.
- `BLANK` - default to a blank commit message.'
merge_commit_title:
type: string
example: PR_TITLE
enum:
- PR_TITLE
- MERGE_MESSAGE
description: "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)."
merge_commit_message:
type: string
example: PR_BODY
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: 'The default value for a merge commit message.
- `PR_TITLE` - default to the pull request''s title.
- `PR_BODY` - default to the pull request''s body.
- `BLANK` - default to a blank commit message.'
allow_forking:
type: boolean
example: true
web_commit_signoff_required:
type: boolean
example: false
subscribers_count:
type: integer
example: 42
network_count:
type: integer
example: 0
license:
$ref: '#/components/schemas/nullable-license-simple_4'
organization:
$ref: '#/components/schemas/nullable-simple-user_8'
parent:
$ref: '#/components/schemas/repository_3'
source:
$ref: '#/components/schemas/repository_3'
forks:
type: integer
master_branch:
type: string
open_issues:
type: integer
watchers:
type: integer
anonymous_access_enabled:
description: Whether anonymous git access is allowed.
default: true
type: boolean
code_of_conduct:
$ref: '#/components/schemas/code-of-conduct-simple'
security_and_analysis:
$ref: '#/components/schemas/security-and-analysis'
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_issues
- has_projects
- has_wiki
- has_pages
- has_discussions
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
- network_count
- subscribers_count
secret-scanning-alert-state:
description: Sets the state of the secret scanning alert. You must provide `resolution` when you set the state to `resolved`.
type: string
enum:
- open
- resolved
reaction-rollup:
title: Reaction Rollup
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
total_count:
type: integer
example: 42
'+1':
type: integer
example: 42
'-1':
type: integer
example: 42
laugh:
type: integer
example: 42
confused:
type: integer
example: 42
heart:
type: integer
example: 42
hooray:
type: integer
example: 42
eyes:
type: integer
example: 42
rocket:
type: integer
example: 42
required:
- url
- total_count
- '+1'
- '-1'
- laugh
- confused
- heart
- hooray
- eyes
- rocket
deployment-branch-policy-name-pattern:
title: Deployment branch policy name pattern
type: object
properties:
name:
description: 'The name pattern that branches must match in order to deploy to the environment.
Wildcard characters will not match `/`. For example, to match branches that begin with `release/` and contain an additional single slash, use `release/*/*`.
For more information about pattern matching syntax, see the [Ruby File.fnmatch documentation](https://ruby-doc.org/core-2.5.1/File.html#method-c-fnmatch).'
type: string
example: release/*
required:
- name
milestone:
title: Milestone
description: collection of related issues and pull requests.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id:
type: integer
example: 1002604
node_id:
type: string
example: MDk6TWlsZXN0b25lMTAwMjYwNA==
number:
description: The number of the milestone.
type: integer
example: 42
state:
description: The state of the milestone.
example: open
type: string
enum:
- open
- closed
default: open
title:
description: The title of the milestone.
example: v1.0
type: string
description:
type: string
example: Tracking milestone for version 1.0
creator:
$ref: '#/components/schemas/nullable-simple-user_8'
open_issues:
type: integer
example: 4
closed_issues:
type: integer
example: 8
created_at:
type: string
format: date-time
example: '2011-04-10T20:09:31Z'
updated_at:
type: string
format: date-time
example: '2014-03-03T18:58:10Z'
closed_at:
type: string
format: date-time
example: '2013-02-12T13:22:01Z'
due_on:
type: string
format: date-time
example: '2012-10-09T23:39:01Z'
required:
- closed_issues
- creator
- description
- due_on
- closed_at
- id
- node_id
- labels_url
- html_url
- number
- open_issues
- state
- title
- url
- created_at
- updated_at
alert-auto-dismissed-at:
type: string
description: 'The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
team:
title: Team
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
name:
type: string
example: octocat
slug:
type: string
example: example_value
description:
type: string
example: This is an example repository
privacy:
type: string
example: example_value
permission:
type: string
example: example_value
permissions:
type: object
properties:
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
admin:
type: boolean
required:
- pull
- triage
- push
- maintain
- admin
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
members_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
repositories_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
parent:
$ref: '#/components/schemas/nullable-team-simple_2'
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
- parent
team-organization:
title: Team Organization
description: Team Organization
type: object
properties:
login:
type: string
example: github
id:
type: integer
example: 1
node_id:
type: string
example: MDEyOk9yZ2FuaXphdGlvbjE=
url:
type: string
format: uri
example: https://api.github.com/orgs/github
repos_url:
type: string
format: uri
example: https://api.github.com/orgs/github/repos
events_url:
type: string
format: uri
example: https://api.github.com/orgs/github/events
hooks_url:
type: string
example: https://api.github.com/orgs/github/hooks
issues_url:
type: string
example: https://api.github.com/orgs/github/issues
members_url:
type: string
example: https://api.github.com/orgs/github/members{/member}
public_members_url:
type: string
example: https://api.github.com/orgs/github/public_members{/member}
avatar_url:
type: string
example: https://github.com/images/error/octocat_happy.gif
description:
type: string
example: A great organization
nullable: true
name:
type: string
example: github
company:
type: string
example: GitHub
blog:
type: string
format: uri
example: https://github.com/blog
location:
type: string
example: San Francisco
email:
type: string
format: email
example: octocat@github.com
twitter_username:
type: string
example: github
nullable: true
is_verified:
type: boolean
example: true
has_organization_projects:
type: boolean
example: true
has_repository_projects:
type: boolean
example: true
public_repos:
type: integer
example: 2
public_gists:
type: integer
example: 1
followers:
type: integer
example: 20
following:
type: integer
example: 0
html_url:
type: string
format: uri
example: https://github.com/octocat
created_at:
type: string
format: date-time
example: '2008-01-14T04:33:35Z'
type:
type: string
example: Organization
total_private_repos:
type: integer
example: 100
owned_private_repos:
type: integer
example: 100
private_gists:
type: integer
example: 81
nullable: true
disk_usage:
type: integer
example: 10000
nullable: true
collaborators:
type: integer
example: 8
nullable: true
billing_email:
type: string
format: email
example: org@example.com
nullable: true
plan:
type: object
properties:
name:
type: string
space:
type: integer
private_repos:
type: integer
filled_seats:
type: integer
seats:
type: integer
required:
- name
- space
- private_repos
default_repository_permission:
type: string
nullable: true
members_can_create_repositories:
type: boolean
example: true
nullable: true
two_factor_requirement_enabled:
type: boolean
example: true
nullable: true
members_allowed_repository_creation_type:
type: string
example: all
members_can_create_public_repositories:
type: boolean
example: true
members_can_create_private_repositories:
type: boolean
example: true
members_can_create_internal_repositories:
type: boolean
example: true
members_can_create_pages:
type: boolean
example: true
members_can_create_public_pages:
type: boolean
example: true
members_can_create_private_pages:
type: boolean
example: true
members_can_fork_private_repositories:
type: boolean
example: false
nullable: true
web_commit_signoff_required:
type: boolean
example: false
updated_at:
type: string
format: date-time
required:
- login
- url
- id
- node_id
- repos_url
- events_url
- hooks_url
- issues_url
- members_url
- public_members_url
- avatar_url
- description
- html_url
- has_organization_projects
- has_repository_projects
- public_repos
- public_gists
- followers
- following
- type
- created_at
- updated_at
- archived_at
team-membership:
title: Team Membership
description: Team Membership
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
role:
description: The role of the user in the team.
enum:
- member
- maintainer
default: member
example: member
type: string
state:
description: The state of the user's membership in the team.
type: string
enum:
- active
- pending
example: active
required:
- role
- state
- url
private-user:
title: Private User
description: Private User
type: object
properties:
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
name:
type: string
example: monalisa octocat
nullable: true
company:
type: string
example: GitHub
nullable: true
blog:
type: string
example: https://github.com/blog
nullable: true
location:
type: string
example: San Francisco
nullable: true
email:
type: string
format: email
example: octocat@github.com
nullable: true
hireable:
type: boolean
nullable: true
bio:
type: string
example: There once was...
nullable: true
twitter_username:
type: string
example: monalisa
nullable: true
public_repos:
type: integer
example: 2
public_gists:
type: integer
example: 1
followers:
type: integer
example: 20
following:
type: integer
example: 0
created_at:
type: string
format: date-time
example: '2008-01-14T04:33:35Z'
updated_at:
type: string
format: date-time
example: '2008-01-14T04:33:35Z'
private_gists:
type: integer
example: 81
total_private_repos:
type: integer
example: 100
owned_private_repos:
type: integer
example: 100
disk_usage:
type: integer
example: 10000
collaborators:
type: integer
example: 8
two_factor_authentication:
type: boolean
example: true
plan:
type: object
properties:
collaborators:
type: integer
name:
type: string
space:
type: integer
private_repos:
type: integer
required:
- collaborators
- name
- space
- private_repos
suspended_at:
type: string
format: date-time
nullable: true
business_plus:
type: boolean
ldap_dn:
type: string
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
- bio
- blog
- company
- email
- followers
- following
- hireable
- location
- name
- public_gists
- public_repos
- created_at
- updated_at
- collaborators
- disk_usage
- owned_private_repos
- private_gists
- total_private_repos
- two_factor_authentication
simple-user_5:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
pull-request-review:
title: Pull Request Review
description: Pull Request Reviews are reviews on pull requests.
type: object
properties:
id:
description: Unique identifier of the review
example: 42
type: integer
node_id:
type: string
example: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
user:
$ref: '#/components/schemas/nullable-simple-user_7'
body:
description: The text of the review.
example: This looks great.
type: string
state:
type: string
example: CHANGES_REQUESTED
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
pull_request_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/12
_links:
type: object
properties:
html:
type: object
properties:
href:
type: string
required:
- href
pull_request:
type: object
properties:
href:
type: string
required:
- href
required:
- html
- pull_request
submitted_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
commit_id:
description: commit SHA for the review. If the commit object was garbage collected or forcibly deleted, then it no longer exists in Git and this value will be `null`.
example: 54bb654c9e6025347f57900a4a5c2313a96b8035
type: string
body_html:
type: string
example: Example body text
body_text:
type: string
example: Example body text
author_association:
$ref: '#/components/schemas/author-association'
required:
- id
- node_id
- user
- body
- state
- commit_id
- html_url
- pull_request_url
- _links
- author_association
dependabot-alert:
type: object
description: Dependabot alert.
properties:
number:
$ref: '#/components/schemas/alert-number'
state:
type: string
description: The state of the Dependabot alert.
readOnly: true
enum:
- auto_dismissed
- dismissed
- fixed
- open
example: auto_dismissed
dependency:
type: object
description: Details for the vulnerable dependency.
readOnly: true
properties:
package:
$ref: '#/components/schemas/dependabot-alert-package'
manifest_path:
type: string
description: The full path to the dependency manifest file, relative to the root of the repository.
readOnly: true
scope:
type: string
description: The execution scope of the vulnerable dependency.
readOnly: true
enum:
- development
- runtime
security_advisory:
$ref: '#/components/schemas/dependabot-alert-security-advisory'
security_vulnerability:
$ref: '#/components/schemas/dependabot-alert-security-vulnerability'
url:
$ref: '#/components/schemas/alert-url'
html_url:
$ref: '#/components/schemas/alert-html-url'
created_at:
$ref: '#/components/schemas/alert-created-at'
updated_at:
$ref: '#/components/schemas/alert-updated-at'
dismissed_at:
$ref: '#/components/schemas/alert-dismissed-at'
dismissed_by:
$ref: '#/components/schemas/nullable-simple-user_4'
dismissed_reason:
type: string
description: The reason that the alert was dismissed.
enum:
- fix_started
- inaccurate
- no_bandwidth
- not_used
- tolerable_risk
example: fix_started
dismissed_comment:
type: string
description: An optional comment associated with the alert's dismissal.
maxLength: 280
example: example_value
fixed_at:
$ref: '#/components/schemas/alert-fixed-at'
auto_dismissed_at:
$ref: '#/components/schemas/alert-auto-dismissed-at'
required:
- number
- state
- dependency
- security_advisory
- security_vulnerability
- url
- html_url
- created_at
- updated_at
- dismissed_at
- dismissed_by
- dismissed_reason
- dismissed_comment
- fixed_at
additionalProperties: false
project-card:
title: Project Card
description: Project cards represent a scope of work.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/projects/columns/cards/1478
id:
description: The project card's ID
example: 42
type: integer
node_id:
type: string
example: MDExOlByb2plY3RDYXJkMTQ3OA==
note:
type: string
example: Add payload for delete Project column
nullable: true
creator:
$ref: '#/components/schemas/nullable-simple-user'
created_at:
type: string
format: date-time
example: '2016-09-05T14:21:06Z'
updated_at:
type: string
format: date-time
example: '2016-09-05T14:20:22Z'
archived:
description: Whether or not the card is archived
example: false
type: boolean
column_name:
type: string
example: octocat
project_id:
type: string
example: '12345678'
column_url:
type: string
format: uri
example: https://api.github.com/projects/columns/367
content_url:
type: string
format: uri
example: https://api.github.com/repos/api-playground/projects-test/issues/3
project_url:
type: string
format: uri
example: https://api.github.com/projects/120
required:
- id
- node_id
- note
- url
- column_url
- project_url
- creator
- created_at
- updated_at
link:
title: Link
description: Hypermedia Link
type: object
properties:
href:
type: string
example: https://api.github.com/repos/octocat/Hello-World
required:
- href
dependabot-alert-package:
type: object
description: Details for the vulnerable package.
readOnly: true
properties:
ecosystem:
type: string
description: The package's language or package management ecosystem.
readOnly: true
example: example_value
name:
type: string
description: The unique package name within its ecosystem.
readOnly: true
example: octocat
required:
- ecosystem
- name
additionalProperties: false
project:
title: Project
description: Projects are a way to organize columns and cards of work.
type: object
properties:
owner_url:
type: string
format: uri
example: https://api.github.com/repos/api-playground/projects-test
url:
type: string
format: uri
example: https://api.github.com/projects/1002604
html_url:
type: string
format: uri
example: https://github.com/api-playground/projects-test/projects/12
columns_url:
type: string
format: uri
example: https://api.github.com/projects/1002604/columns
id:
type: integer
example: 1002604
node_id:
type: string
example: MDc6UHJvamVjdDEwMDI2MDQ=
name:
description: Name of the project
example: Week One Sprint
type: string
body:
description: Body of the project
example: This project represents the sprint of the first week in January
type: string
nullable: true
number:
type: integer
example: 1
state:
description: State of the project; either 'open' or 'closed'
example: open
type: string
creator:
$ref: '#/components/schemas/nullable-simple-user'
created_at:
type: string
format: date-time
example: '2011-04-10T20:09:31Z'
updated_at:
type: string
format: date-time
example: '2014-03-03T18:58:10Z'
organization_permission:
description: The baseline permission that all organization members have on this project. Only present if owner is an organization.
type: string
enum:
- read
- write
- admin
- none
example: read
private:
description: Whether or not this project can be seen by everyone. Only present if owner is an organization.
type: boolean
example: true
required:
- id
- node_id
- number
- name
- body
- state
- url
- html_url
- owner_url
- creator
- columns_url
- created_at
- updated_at
org-pre-receive-hook:
type: object
properties:
id:
type: integer
example: 42
name:
type: string
example: octocat
enforcement:
type: string
example: example_value
configuration_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
allow_downstream_configuration:
type: boolean
example: true
authorization:
title: Authorization
description: The authorization for an OAuth app, GitHub App, or a Personal Access Token.
type: object
properties:
id:
type: integer
example: 42
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
scopes:
description: A list of scopes that this authorization is in.
type: array
items:
type: string
nullable: true
token:
type: string
example: example_value
token_last_eight:
type: string
nullable: true
example: example_value
hashed_token:
type: string
nullable: true
example: example_value
app:
type: object
properties:
client_id:
type: string
name:
type: string
url:
type: string
format: uri
required:
- client_id
- name
- url
note:
type: string
nullable: true
example: example_value
note_url:
type: string
format: uri
nullable: true
example: https://api.github.com/repos/octocat/Hello-World
updated_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
created_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
fingerprint:
type: string
nullable: true
example: example_value
user:
$ref: '#/components/schemas/nullable-simple-user'
installation:
$ref: '#/components/schemas/nullable-scoped-installation'
expires_at:
type: string
format: date-time
nullable: true
example: '2026-04-17T12:00:00Z'
required:
- app
- id
- note
- note_url
- scopes
- token
- hashed_token
- token_last_eight
- fingerprint
- url
- created_at
- updated_at
- expires_at
patch-schema:
type: object
required:
- Operations
- schemas
properties:
Operations:
type: array
description: patch operations list
items:
type: object
required:
- op
properties:
op:
type: string
enum:
- add
- replace
- remove
path:
type: string
value:
type: string
description: Corresponding 'value' of that field specified by 'path'
schemas:
type: array
items:
type: string
enum:
- urn:ietf:params:scim:api:messages:2.0:PatchOp
gist-comment:
title: Gist Comment
description: A comment made to a gist.
type: object
properties:
id:
type: integer
example: 1
node_id:
type: string
example: MDExOkdpc3RDb21tZW50MQ==
url:
type: string
format: uri
example: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1
body:
description: The comment text.
type: string
maxLength: 65535
example: Body of the attachment
user:
$ref: '#/components/schemas/nullable-simple-user'
created_at:
type: string
format: date-time
example: '2011-04-18T23:23:56Z'
updated_at:
type: string
format: date-time
example: '2011-04-18T23:23:56Z'
author_association:
$ref: '#/components/schemas/author-association'
required:
- url
- id
- node_id
- user
- body
- author_association
- created_at
- updated_at
code-scanning-analysis-category:
type: string
description: Identifies the configuration under which the analysis was executed. Used to distinguish between multiple analyses for the same tool and commit, but performed on different languages or different parts of the code.
code-scanning-analysis-tool:
type: object
properties:
name:
$ref: '#/components/schemas/code-scanning-analysis-tool-name'
version:
$ref: '#/components/schemas/code-scanning-analysis-tool-version'
guid:
$ref: '#/components/schemas/code-scanning-analysis-tool-guid'
security-and-analysis:
type: object
properties:
advanced_security:
type: object
properties:
status:
type: string
enum:
- enabled
- disabled
secret_scanning:
type: object
properties:
status:
type: string
enum:
- enabled
- disabled
secret_scanning_push_protection:
type: object
properties:
status:
type: string
enum:
- enabled
- disabled
org-hook:
title: Org Hook
description: Org Hook
type: object
properties:
id:
type: integer
example: 1
url:
type: string
format: uri
example: https://api.github.com/orgs/octocat/hooks/1
ping_url:
type: string
format: uri
example: https://api.github.com/orgs/octocat/hooks/1/pings
deliveries_url:
type: string
format: uri
example: https://api.github.com/orgs/octocat/hooks/1/deliveries
name:
type: string
example: web
events:
type: array
example:
- push
- pull_request
items:
type: string
active:
type: boolean
example: true
config:
type: object
properties:
url:
type: string
example: '"http://example.com/2"'
insecure_ssl:
type: string
example: '"0"'
content_type:
type: string
example: '"form"'
secret:
type: string
example: '"********"'
updated_at:
type: string
format: date-time
example: '2011-09-06T20:39:23Z'
created_at:
type: string
format: date-time
example: '2011-09-06T17:26:27Z'
type:
type: string
example: User
required:
- id
- url
- type
- name
- active
- events
- config
- ping_url
- created_at
- updated_at
group-response:
type: object
required:
- schemas
properties:
schemas:
type: array
description: The URIs that are used to indicate the namespaces of the SCIM schemas.
items:
type: string
enum:
- urn:ietf:params:scim:schemas:core:2.0:Group
- urn:ietf:params:scim:api:messages:2.0:ListResponse
example:
- urn:ietf:params:scim:schemas:core:2.0:Group
externalId:
type: string
description: A unique identifier for the resource as defined by the provisioning client.
example: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
nullable: true
displayName:
type: string
description: A human-readable name for a security group.
example: Engineering
nullable: true
members:
type: array
description: The group members.
items:
type: object
required:
- value
- $ref
properties:
value:
type: string
description: The local unique identifier for the member
example: 23a35c27-23d3-4c03-b4c5-6443c09e7173
$ref:
type: string
display:
type: string
description: The display name associated with the member
example: Monalisa Octocat
empty-object_3:
title: Empty Object
description: An object without any properties.
type: object
additionalProperties: false
nullable-alert-updated-at:
type: string
description: 'The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
code-scanning-default-setup-update-response:
description: 'You can use `run_url` 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 run object.'
type: object
properties:
run_id:
description: ID of the corresponding run.
type: integer
example: 42
run_url:
description: URL of the corresponding run.
type: string
example: https://api.github.com/repos/octocat/Hello-World
nullable-simple-user_5:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
code-scanning-alert-environment:
type: string
description: Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed.
label:
title: Label
description: Color-coded labels help you categorize and filter your issues (just like labels in Gmail).
type: object
properties:
id:
type: integer
format: int64
example: 208045946
node_id:
type: string
example: MDU6TGFiZWwyMDgwNDU5NDY=
url:
description: URL for the label
example: https://api.github.com/repositories/42/labels/bug
type: string
format: uri
name:
description: The name of the label.
example: bug
type: string
description:
type: string
example: Something isn't working
color:
description: '6-character hex code, without the leading #, identifying the color'
example: FFFFFF
type: string
default:
type: boolean
example: true
required:
- id
- node_id
- url
- name
- description
- color
- default
code-scanning-analysis-analysis-key:
type: string
description: Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name.
code-of-conduct:
title: Code Of Conduct
description: Code Of Conduct
type: object
properties:
key:
type: string
example: contributor_covenant
name:
type: string
example: Contributor Covenant
url:
type: string
format: uri
example: https://api.github.com/codes_of_conduct/contributor_covenant
body:
type: string
example: "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n"
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
required:
- url
- html_url
- key
- name
user-emails-response:
type: array
description: The emails for the user.
items:
type: object
required:
- value
properties:
value:
type: string
description: The email address.
example: mlisa@example.com
type:
type: string
description: The type of email address.
example: work
primary:
type: boolean
description: Whether this email address is the primary address.
example: true
code-scanning-alert-rule:
type: object
properties:
id:
type: string
description: unique identifier for the rule used to detect the alert.
example: '12345678'
name:
type: string
description: The name of the rule used to detect the alert.
example: octocat
severity:
type: string
description: The severity of the alert.
enum:
- none
- note
- warning
- error
example: none
security_severity_level:
type: string
description: The security severity of the alert.
enum:
- low
- medium
- high
- critical
example: low
description:
type: string
description: short description of the rule used to detect the alert.
example: This is an example repository
full_description:
type: string
description: description of the rule used to detect the alert.
example: This is an example repository
tags:
type: array
description: set of tags applicable for the rule.
items:
type: string
help:
type: string
description: Detailed documentation for the rule as GitHub Flavored Markdown.
example: example_value
help_uri:
type: string
description: link to the documentation for the rule used to detect the alert.
example: example_value
nullable-simple-user_3:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
issue-comment:
title: Issue Comment
description: Comments provide a way for people to collaborate on an issue.
type: object
properties:
id:
description: Unique identifier of the issue comment
example: 42
type: integer
format: int64
node_id:
type: string
example: '12345678'
url:
description: URL for the issue comment
example: https://api.github.com/repositories/42/issues/comments/1
type: string
format: uri
body:
description: Contents of the issue comment
example: What version of Safari were you using when you observed this bug?
type: string
body_text:
type: string
example: Example body text
body_html:
type: string
example: Example body text
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
user:
$ref: '#/components/schemas/nullable-simple-user'
created_at:
type: string
format: date-time
example: '2011-04-14T16:00:49Z'
updated_at:
type: string
format: date-time
example: '2011-04-14T16:00:49Z'
issue_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
author_association:
$ref: '#/components/schemas/author-association'
performed_via_github_app:
$ref: '#/components/schemas/nullable-integration'
reactions:
$ref: '#/components/schemas/reaction-rollup'
required:
- id
- node_id
- html_url
- issue_url
- author_association
- user
- url
- created_at
- updated_at
file-commit:
title: File Commit
description: File Commit
type: object
required:
- content
- commit
properties:
content:
type: object
properties:
name:
type: string
path:
type: string
sha:
type: string
size:
type: integer
url:
type: string
html_url:
type: string
git_url:
type: string
download_url:
type: string
type:
type: string
_links:
type: object
properties:
self:
type: string
git:
type: string
html:
type: string
commit:
type: object
properties:
sha:
type: string
node_id:
type: string
url:
type: string
html_url:
type: string
author:
type: object
properties:
date:
type: string
name:
type: string
email:
type: string
committer:
type: object
properties:
date:
type: string
name:
type: string
email:
type: string
message:
type: string
tree:
type: object
properties:
url:
type: string
sha:
type: string
parents:
type: array
items:
type: object
properties:
url:
type: string
html_url:
type: string
sha:
type: string
verification:
type: object
properties:
verified:
type: boolean
reason:
type: string
signature:
type: string
payload:
type: string
nullable-simple-user_2:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
basic-error:
title: Basic Error
description: Basic Error
type: object
properties:
message:
type: string
example: Example body text
documentation_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
status:
type: string
example: open
nullable-simple-user_8:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
project-column:
title: Project Column
description: Project columns contain cards of work.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/projects/columns/367
project_url:
type: string
format: uri
example: https://api.github.com/projects/120
cards_url:
type: string
format: uri
example: https://api.github.com/projects/columns/367/cards
id:
description: The unique identifier of the project column
example: 42
type: integer
node_id:
type: string
example: MDEzOlByb2plY3RDb2x1bW4zNjc=
name:
description: Name of the project column
example: Remaining tasks
type: string
created_at:
type: string
format: date-time
example: '2016-09-05T14:18:44Z'
updated_at:
type: string
format: date-time
example: '2016-09-05T14:22:28Z'
required:
- id
- node_id
- url
- project_url
- cards_url
- name
- created_at
- updated_at
organization-full:
title: Organization Full
description: Organization Full
type: object
properties:
login:
type: string
example: github
id:
type: integer
example: 1
node_id:
type: string
example: MDEyOk9yZ2FuaXphdGlvbjE=
url:
type: string
format: uri
example: https://api.github.com/orgs/github
repos_url:
type: string
format: uri
example: https://api.github.com/orgs/github/repos
events_url:
type: string
format: uri
example: https://api.github.com/orgs/github/events
hooks_url:
type: string
example: https://api.github.com/orgs/github/hooks
issues_url:
type: string
example: https://api.github.com/orgs/github/issues
members_url:
type: string
example: https://api.github.com/orgs/github/members{/member}
public_members_url:
type: string
example: https://api.github.com/orgs/github/public_members{/member}
avatar_url:
type: string
example: https://github.com/images/error/octocat_happy.gif
description:
type: string
example: A great organization
nullable: true
name:
type: string
example: github
company:
type: string
example: GitHub
blog:
type: string
format: uri
example: https://github.com/blog
location:
type: string
example: San Francisco
email:
type: string
format: email
example: octocat@github.com
twitter_username:
type: string
example: github
nullable: true
is_verified:
type: boolean
example: true
has_organization_projects:
type: boolean
example: true
has_repository_projects:
type: boolean
example: true
public_repos:
type: integer
example: 2
public_gists:
type: integer
example: 1
followers:
type: integer
example: 20
following:
type: integer
example: 0
html_url:
type: string
format: uri
example: https://github.com/octocat
type:
type: string
example: Organization
total_private_repos:
type: integer
example: 100
owned_private_repos:
type: integer
example: 100
private_gists:
type: integer
example: 81
nullable: true
disk_usage:
type: integer
example: 10000
nullable: true
collaborators:
type: integer
example: 8
nullable: true
billing_email:
type: string
format: email
example: org@example.com
nullable: true
plan:
type: object
properties:
name:
type: string
space:
type: integer
private_repos:
type: integer
filled_seats:
type: integer
seats:
type: integer
required:
- name
- space
- private_repos
default_repository_permission:
type: string
nullable: true
members_can_create_repositories:
type: boolean
example: true
nullable: true
two_factor_requirement_enabled:
type: boolean
example: true
nullable: true
members_allowed_repository_creation_type:
type: string
example: all
members_can_create_public_repositories:
type: boolean
example: true
members_can_create_private_repositories:
type: boolean
example: true
members_can_create_internal_repositories:
type: boolean
example: true
members_can_create_pages:
type: boolean
example: true
members_can_create_public_pages:
type: boolean
example: true
members_can_create_private_pages:
type: boolean
example: true
members_can_fork_private_repositories:
type: boolean
example: false
nullable: true
web_commit_signoff_required:
type: boolean
example: false
advanced_security_enabled_for_new_repositories:
type: boolean
example: false
description: 'Whether GitHub Advanced Security is enabled for new repositories and repositories transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.'
dependabot_alerts_enabled_for_new_repositories:
type: boolean
example: false
description: 'Whether GitHub Advanced Security is automatically enabled for new repositories and repositories transferred to
this organization.
This field is only visible to organization owners or members of a team with the security manager role.'
dependabot_security_updates_enabled_for_new_repositories:
type: boolean
example: false
description: 'Whether dependabot security updates are automatically enabled for new repositories and repositories transferred
to this organization.
This field is only visible to organization owners or members of a team with the security manager role.'
dependency_graph_enabled_for_new_repositories:
type: boolean
example: false
description: 'Whether dependency graph is automatically enabled for new repositories and repositories transferred to this
organization.
This field is only visible to organization owners or members of a team with the security manager role.'
secret_scanning_enabled_for_new_repositories:
type: boolean
example: false
description: 'Whether secret scanning is automatically enabled for new repositories and repositories transferred to this
organization.
This field is only visible to organization owners or members of a team with the security manager role.'
secret_scanning_push_protection_enabled_for_new_repositories:
type: boolean
example: false
description: 'Whether secret scanning push protection is automatically enabled for new repositories and repositories
transferred to this organization.
This field is only visible to organization owners or members of a team with the security manager role.'
secret_scanning_push_protection_custom_link_enabled:
type: boolean
example: false
description: Whether a custom link is shown to contributors who are blocked from pushing a secret by push protection.
secret_scanning_push_protection_custom_link:
type: string
example: https://github.com/test-org/test-repo/blob/main/README.md
nullable: true
description: An optional URL string to display to contributors who are blocked from pushing a secret.
created_at:
type: string
format: date-time
example: '2008-01-14T04:33:35Z'
updated_at:
type: string
format: date-time
required:
- login
- url
- id
- node_id
- repos_url
- events_url
- hooks_url
- issues_url
- members_url
- public_members_url
- avatar_url
- description
- html_url
- has_organization_projects
- has_repository_projects
- public_repos
- public_gists
- followers
- following
- type
- created_at
- updated_at
- archived_at
team-simple:
title: Team Simple
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
description: Unique identifier of the team
type: integer
example: 1
node_id:
type: string
example: MDQ6VGVhbTE=
url:
description: URL for the team
type: string
format: uri
example: https://api.github.com/organizations/1/team/1
members_url:
type: string
example: https://api.github.com/organizations/1/team/1/members{/member}
name:
description: Name of the team
type: string
example: Justice League
description:
description: Description of the team
type: string
example: great team.
permission:
description: Permission that the team will have for its repositories
type: string
example: admin
privacy:
description: The level of privacy this team should have
type: string
example: closed
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
repositories_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/1/repos
slug:
type: string
example: justice-league
ldap_dn:
description: Distinguished Name (DN) that team maps to within LDAP environment
example: uid=example,ou=users,dc=github,dc=com
type: string
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
nullable-license-simple_3:
title: License Simple
description: License Simple
type: object
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
required:
- key
- name
- url
- spdx_id
- node_id
scim-enterprise-user-response:
allOf:
- $ref: '#/components/schemas/user-response'
- type: object
required:
- id
- meta
properties:
id:
type: string
description: The internally generated id for the user object.
example: 7fce0092-d52e-4f76-b727-3955bd72c939
groups:
type: array
items:
type: object
properties:
value:
type: string
$ref:
type: string
display:
type: string
description: Provisioned SCIM groups that the user is a member of.
meta:
$ref: '#/components/schemas/meta'
app-permissions:
title: App Permissions
type: object
description: The permissions granted to the user access token.
properties:
actions:
type: string
description: The level of permission to grant the access token for GitHub Actions workflows, workflow runs, and artifacts.
enum:
- read
- write
example: read
administration:
type: string
description: The level of permission to grant the access token for repository creation, deletion, settings, teams, and collaborators creation.
enum:
- read
- write
example: read
checks:
type: string
description: The level of permission to grant the access token for checks on code.
enum:
- read
- write
example: read
codespaces:
type: string
description: The level of permission to grant the access token to create, edit, delete, and list Codespaces.
enum:
- read
- write
example: read
contents:
type: string
description: The level of permission to grant the access token for repository contents, commits, branches, downloads, releases, and merges.
enum:
- read
- write
example: read
dependabot_secrets:
type: string
description: The leve of permission to grant the access token to manage Dependabot secrets.
enum:
- read
- write
example: read
deployments:
type: string
description: The level of permission to grant the access token for deployments and deployment statuses.
enum:
- read
- write
example: read
environments:
type: string
description: The level of permission to grant the access token for managing repository environments.
enum:
- read
- write
example: read
issues:
type: string
description: The level of permission to grant the access token for issues and related comments, assignees, labels, and milestones.
enum:
- read
- write
example: read
metadata:
type: string
description: The level of permission to grant the access token to search repositories, list collaborators, and access repository metadata.
enum:
- read
- write
example: read
packages:
type: string
description: The level of permission to grant the access token for packages published to GitHub Packages.
enum:
- read
- write
example: read
pages:
type: string
description: The level of permission to grant the access token to retrieve Pages statuses, configuration, and builds, as well as create new builds.
enum:
- read
- write
example: read
pull_requests:
type: string
description: The level of permission to grant the access token for pull requests and related comments, assignees, labels, milestones, and merges.
enum:
- read
- write
example: read
repository_hooks:
type: string
description: The level of permission to grant the access token to manage the post-receive hooks for a repository.
enum:
- read
- write
example: read
repository_projects:
type: string
description: The level of permission to grant the access token to manage repository projects, columns, and cards.
enum:
- read
- write
- admin
example: read
secret_scanning_alerts:
type: string
description: The level of permission to grant the access token to view and manage secret scanning alerts.
enum:
- read
- write
example: read
secrets:
type: string
description: The level of permission to grant the access token to manage repository secrets.
enum:
- read
- write
example: read
security_events:
type: string
description: The level of permission to grant the access token to view and manage security events like code scanning alerts.
enum:
- read
- write
example: read
single_file:
type: string
description: The level of permission to grant the access token to manage just a single file.
enum:
- read
- write
example: read
statuses:
type: string
description: The level of permission to grant the access token for commit statuses.
enum:
- read
- write
example: read
vulnerability_alerts:
type: string
description: The level of permission to grant the access token to manage Dependabot alerts.
enum:
- read
- write
workflows:
type: string
description: The level of permission to grant the access token to update GitHub Actions workflow files.
enum:
- write
members:
type: string
description: The level of permission to grant the access token for organization teams and members.
enum:
- read
- write
organization_administration:
type: string
description: The level of permission to grant the access token to manage access to an organization.
enum:
- read
- write
organization_custom_roles:
type: string
description: The level of permission to grant the access token for custom repository roles management.
enum:
- read
- write
organization_copilot_seat_management:
type: string
description: The level of permission to grant the access token for managing access to GitHub Copilot for members of an organization with a Copilot Business subscription. This property is in beta and is subject to change.
enum:
- write
organization_announcement_banners:
type: string
description: The level of permission to grant the access token to view and manage announcement banners for an organization.
enum:
- read
- write
organization_events:
type: string
description: The level of permission to grant the access token to view events triggered by an activity in an organization.
enum:
- read
organization_hooks:
type: string
description: The level of permission to grant the access token to manage the post-receive hooks for an organization.
enum:
- read
- write
organization_personal_access_tokens:
type: string
description: The level of permission to grant the access token for viewing and managing fine-grained personal access token requests to an organization.
enum:
- read
- write
organization_personal_access_token_requests:
type: string
description: The level of permission to grant the access token for viewing and managing fine-grained personal access tokens that have been approved by an organization.
enum:
- read
- write
organization_plan:
type: string
description: The level of permission to grant the access token for viewing an organization's plan.
enum:
- read
organization_projects:
type: string
description: The level of permission to grant the access token to manage organization projects and projects beta (where available).
enum:
- read
- write
- admin
organization_packages:
type: string
description: The level of permission to grant the access token for organization packages published to GitHub Packages.
enum:
- read
- write
organization_secrets:
type: string
description: The level of permission to grant the access token to manage organization secrets.
enum:
- read
- write
organization_self_hosted_runners:
type: string
description: The level of permission to grant the access token to view and manage GitHub Actions self-hosted runners available to an organization.
enum:
- read
- write
organization_user_blocking:
type: string
description: The level of permission to grant the access token to view and manage users blocked by the organization.
enum:
- read
- write
team_discussions:
type: string
description: The level of permission to grant the access token to manage team discussions and related comments.
enum:
- read
- write
email_addresses:
type: string
description: The level of permission to grant the access token to manage the email addresses belonging to a user.
enum:
- read
- write
followers:
type: string
description: The level of permission to grant the access token to manage the followers belonging to a user.
enum:
- read
- write
git_ssh_keys:
type: string
description: The level of permission to grant the access token to manage git SSH keys.
enum:
- read
- write
gpg_keys:
type: string
description: The level of permission to grant the access token to view and manage GPG keys belonging to a user.
enum:
- read
- write
interaction_limits:
type: string
description: The level of permission to grant the access token to view and manage interaction limits on a repository.
enum:
- read
- write
profile:
type: string
description: The level of permission to grant the access token to manage the profile settings belonging to a user.
enum:
- write
starring:
type: string
description: The level of permission to grant the access token to list and manage repositories a user is starring.
enum:
- read
- write
example:
contents: read
issues: read
deployments: write
single_file: read
nullable-license-simple_4:
title: License Simple
description: License Simple
type: object
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
required:
- key
- name
- url
- spdx_id
- node_id
nullable-team-simple_2:
title: Team Simple
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
description: Unique identifier of the team
type: integer
example: 1
node_id:
type: string
example: MDQ6VGVhbTE=
url:
description: URL for the team
type: string
format: uri
example: https://api.github.com/organizations/1/team/1
members_url:
type: string
example: https://api.github.com/organizations/1/team/1/members{/member}
name:
description: Name of the team
type: string
example: Justice League
description:
description: Description of the team
type: string
example: great team.
permission:
description: Permission that the team will have for its repositories
type: string
example: admin
privacy:
description: The level of privacy this team should have
type: string
example: closed
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
repositories_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/1/repos
slug:
type: string
example: justice-league
ldap_dn:
description: Distinguished Name (DN) that team maps to within LDAP environment
example: uid=example,ou=users,dc=github,dc=com
type: string
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
team-discussion:
title: Team Discussion
description: A team discussion is a persistent record of a free-form conversation within a team.
type: object
properties:
author:
$ref: '#/components/schemas/nullable-simple-user'
body:
description: The main text of the discussion.
example: Please suggest improvements to our workflow in comments.
type: string
body_html:
type: string
example: Hi! This is an area for us to collaborate as a team
body_version:
description: The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.
example: 0307116bbf7ced493b8d8a346c650b71
type: string
comments_count:
type: integer
example: 0
comments_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2343027/discussions/1/comments
created_at:
type: string
format: date-time
example: '2018-01-25T18:56:31Z'
last_edited_at:
type: string
format: date-time
nullable: true
example: '2026-04-17T12:00:00Z'
html_url:
type: string
format: uri
example: https://github.com/orgs/github/teams/justice-league/discussions/1
node_id:
type: string
example: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
number:
description: The unique sequence number of a team discussion.
example: 42
type: integer
pinned:
description: Whether or not this discussion should be pinned for easy retrieval.
example: true
type: boolean
private:
description: Whether or not this discussion should be restricted to team members and organization owners.
example: true
type: boolean
team_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2343027
title:
description: The title of the discussion.
example: How can we improve our workflow?
type: string
updated_at:
type: string
format: date-time
example: '2018-01-25T18:56:31Z'
url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/2343027/discussions/1
reactions:
$ref: '#/components/schemas/reaction-rollup'
required:
- author
- body
- body_html
- body_version
- comments_count
- comments_url
- created_at
- last_edited_at
- html_url
- pinned
- private
- node_id
- number
- team_url
- title
- updated_at
- url
scim-error:
title: Scim Error
description: Scim Error
type: object
properties:
message:
type: string
example: Example body text
documentation_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
detail:
type: string
example: example_value
status:
type: integer
example: 42
scimType:
type: string
example: User
schemas:
type: array
items:
type: string
secret-scanning-alert-resolution:
type: string
description: '**Required when the `state` is `resolved`.** The reason for resolving the alert.'
enum:
- false_positive
- wont_fix
- revoked
- used_in_tests
simple-user_3:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
issue:
title: Issue
description: Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.
type: object
properties:
id:
type: integer
format: int64
example: 42
node_id:
type: string
example: '12345678'
url:
description: URL for the issue
example: https://api.github.com/repositories/42/issues/1
type: string
format: uri
repository_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
labels_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
comments_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
events_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
number:
description: Number uniquely identifying the issue within its repository
example: 42
type: integer
state:
description: State of the issue; either 'open' or 'closed'
example: open
type: string
state_reason:
description: The reason for the current state
example: not_planned
type: string
nullable: true
enum:
- completed
- reopened
- not_planned
title:
description: Title of the issue
example: Widget creation fails in Safari on OS X 10.8
type: string
body:
description: Contents of the issue
example: It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?
type: string
nullable: true
user:
$ref: '#/components/schemas/nullable-simple-user'
labels:
description: Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository
example:
- bug
- registration
type: array
items:
oneOf:
- type: string
- type: object
properties:
id:
type: integer
format: int64
node_id:
type: string
url:
type: string
format: uri
name:
type: string
description:
type: string
nullable: true
color:
type: string
nullable: true
default:
type: boolean
assignee:
$ref: '#/components/schemas/nullable-simple-user'
assignees:
type: array
items:
$ref: '#/components/schemas/simple-user'
nullable: true
milestone:
$ref: '#/components/schemas/nullable-milestone'
locked:
type: boolean
example: true
active_lock_reason:
type: string
nullable: true
example: example_value
comments:
type: integer
pull_request:
type: object
properties:
merged_at:
type: string
format: date-time
nullable: true
diff_url:
type: string
format: uri
nullable: true
html_url:
type: string
format: uri
nullable: true
patch_url:
type: string
format: uri
nullable: true
url:
type: string
format: uri
nullable: true
required:
- diff_url
- html_url
- patch_url
- url
closed_at:
type: string
format: date-time
nullable: true
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
draft:
type: boolean
closed_by:
$ref: '#/components/schemas/nullable-simple-user'
body_html:
type: string
body_text:
type: string
timeline_url:
type: string
format: uri
repository:
$ref: '#/components/schemas/repository'
performed_via_github_app:
$ref: '#/components/schemas/nullable-integration'
author_association:
$ref: '#/components/schemas/author-association'
reactions:
$ref: '#/components/schemas/reaction-rollup'
required:
- assignee
- closed_at
- comments
- comments_url
- events_url
- html_url
- id
- node_id
- labels
- labels_url
- milestone
- number
- repository_url
- state
- locked
- title
- url
- user
- author_association
- created_at
- updated_at
minimal-repository_2:
title: Minimal Repository
description: Minimal Repository
type: object
properties:
id:
type: integer
format: int64
example: 1296269
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
type: string
example: Hello-World
full_name:
type: string
example: octocat/Hello-World
owner:
$ref: '#/components/schemas/simple-user_6'
private:
type: boolean
example: true
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
fork:
type: boolean
example: true
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
issue_comment_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
mirror_url:
type: string
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
homepage:
type: string
language:
type: string
forks_count:
type: integer
stargazers_count:
type: integer
watchers_count:
type: integer
size:
description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
type: integer
default_branch:
type: string
open_issues_count:
type: integer
is_template:
type: boolean
topics:
type: array
items:
type: string
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_downloads:
type: boolean
has_discussions:
type: boolean
archived:
type: boolean
disabled:
type: boolean
visibility:
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43Z'
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43Z'
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
role_name:
type: string
example: admin
temp_clone_token:
type: string
delete_branch_on_merge:
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
code_of_conduct:
$ref: '#/components/schemas/code-of-conduct'
license:
type: object
properties:
key:
type: string
name:
type: string
spdx_id:
type: string
url:
type: string
node_id:
type: string
forks:
type: integer
example: 0
open_issues:
type: integer
example: 0
watchers:
type: integer
example: 0
allow_forking:
type: boolean
web_commit_signoff_required:
type: boolean
example: false
security_and_analysis:
$ref: '#/components/schemas/security-and-analysis'
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
team-full:
title: Full Team
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
description: Unique identifier of the team
example: 42
type: integer
node_id:
type: string
example: MDQ6VGVhbTE=
url:
description: URL for the team
example: https://api.github.com/organizations/1/team/1
type: string
format: uri
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
name:
description: Name of the team
example: Developers
type: string
slug:
type: string
example: justice-league
description:
type: string
example: A great team.
nullable: true
privacy:
description: The level of privacy this team should have
type: string
enum:
- closed
- secret
example: closed
permission:
description: Permission that the team will have for its repositories
example: push
type: string
members_url:
type: string
example: https://api.github.com/organizations/1/team/1/members{/member}
repositories_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/1/repos
parent:
$ref: '#/components/schemas/nullable-team-simple'
members_count:
type: integer
example: 3
repos_count:
type: integer
example: 10
created_at:
type: string
format: date-time
example: '2017-07-14T16:53:42Z'
updated_at:
type: string
format: date-time
example: '2017-08-17T12:37:15Z'
organization:
$ref: '#/components/schemas/team-organization'
ldap_dn:
description: Distinguished Name (DN) that team maps to within LDAP environment
example: uid=example,ou=users,dc=github,dc=com
type: string
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
- created_at
- updated_at
- members_count
- repos_count
- organization
minimal-repository:
title: Minimal Repository
description: Minimal Repository
type: object
properties:
id:
type: integer
format: int64
example: 1296269
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
type: string
example: Hello-World
full_name:
type: string
example: octocat/Hello-World
owner:
$ref: '#/components/schemas/simple-user_3'
private:
type: boolean
example: true
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
fork:
type: boolean
example: true
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
issue_comment_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
mirror_url:
type: string
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
homepage:
type: string
language:
type: string
forks_count:
type: integer
stargazers_count:
type: integer
watchers_count:
type: integer
size:
description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
type: integer
default_branch:
type: string
open_issues_count:
type: integer
is_template:
type: boolean
topics:
type: array
items:
type: string
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_downloads:
type: boolean
has_discussions:
type: boolean
archived:
type: boolean
disabled:
type: boolean
visibility:
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43Z'
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43Z'
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
role_name:
type: string
example: admin
temp_clone_token:
type: string
delete_branch_on_merge:
type: boolean
subscribers_count:
type: integer
network_count:
type: integer
code_of_conduct:
$ref: '#/components/schemas/code-of-conduct'
license:
type: object
properties:
key:
type: string
name:
type: string
spdx_id:
type: string
url:
type: string
node_id:
type: string
forks:
type: integer
example: 0
open_issues:
type: integer
example: 0
watchers:
type: integer
example: 0
allow_forking:
type: boolean
web_commit_signoff_required:
type: boolean
example: false
security_and_analysis:
$ref: '#/components/schemas/security-and-analysis'
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
organization-custom-repository-role-update-schema:
type: object
properties:
name:
description: The name of the custom role.
type: string
example: octocat
description:
description: A short description about who this role is for or what permissions it grants.
type: string
nullable: true
example: This is an example repository
base_role:
type: string
description: The system role from which this role inherits permissions.
enum:
- read
- triage
- write
- maintain
example: read
permissions:
description: A list of additional permissions included in this role.
type: array
items:
type: string
simple-user_6:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
code-scanning-analysis-tool-guid:
type: string
description: The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data.
check-run:
title: CheckRun
description: check performed on the code of a given code change
type: object
properties:
id:
description: The id of the check.
example: 21
type: integer
head_sha:
description: The SHA of the commit that is being checked.
example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d
type: string
node_id:
type: string
example: MDg6Q2hlY2tSdW40
external_id:
type: string
example: '42'
url:
type: string
example: https://api.github.com/repos/github/hello-world/check-runs/4
html_url:
type: string
example: https://github.com/github/hello-world/runs/4
details_url:
type: string
example: https://example.com
status:
description: The phase of the lifecycle that the check is currently in. Statuses of waiting, requested, and pending are reserved for GitHub Actions check runs.
example: queued
type: string
enum:
- queued
- in_progress
- completed
- waiting
- requested
- pending
conclusion:
type: string
example: neutral
enum:
- success
- failure
- neutral
- cancelled
- skipped
- timed_out
- action_required
started_at:
type: string
format: date-time
example: '2018-05-04T01:14:52Z'
completed_at:
type: string
format: date-time
example: '2018-05-04T01:14:52Z'
output:
type: object
properties:
title:
type: string
summary:
type: string
text:
type: string
annotations_count:
type: integer
annotations_url:
type: string
format: uri
required:
- title
- summary
- text
- annotations_count
- annotations_url
name:
description: The name of the check.
example: test-coverage
type: string
check_suite:
type: object
properties:
id:
type: integer
required:
- id
app:
$ref: '#/components/schemas/nullable-integration_3'
pull_requests:
description: Pull requests that are open with a `head_sha` or `head_branch` that matches the check. The returned pull requests do not necessarily indicate pull requests that triggered the check.
type: array
items:
$ref: '#/components/schemas/pull-request-minimal'
deployment:
$ref: '#/components/schemas/deployment-simple'
required:
- id
- node_id
- head_sha
- name
- url
- html_url
- details_url
- status
- conclusion
- started_at
- completed_at
- external_id
- check_suite
- output
- app
- pull_requests
nullable-integration_3:
title: GitHub app
description: 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 come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
type: object
properties:
id:
description: Unique identifier of the GitHub app
example: 37
type: integer
slug:
description: The slug name of the GitHub app
example: probot-owners
type: string
node_id:
type: string
example: MDExOkludGVncmF0aW9uMQ==
owner:
$ref: '#/components/schemas/nullable-simple-user_8'
name:
description: The name of the GitHub app
example: Probot Owners
type: string
description:
type: string
example: The description of the app.
external_url:
type: string
format: uri
example: https://example.com
html_url:
type: string
format: uri
example: https://github.com/apps/super-ci
created_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
updated_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
permissions:
description: The set of permissions for the GitHub app
type: object
properties:
issues:
type: string
checks:
type: string
metadata:
type: string
contents:
type: string
deployments:
type: string
additionalProperties:
type: string
example:
issues: read
deployments: write
events:
description: The list of events for the GitHub app
example:
- label
- deployment
type: array
items:
type: string
installations_count:
description: The number of installations associated with the GitHub app
example: 5
type: integer
client_id:
type: string
example: '"Iv1.25b5d1e65ffc4022"'
client_secret:
type: string
example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"'
webhook_secret:
type: string
example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"'
pem:
type: string
example: '"-----BEGIN RSA PRIVATE KEY-----\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n-----END RSA PRIVATE KEY-----\n"'
required:
- id
- node_id
- owner
- name
- description
- external_url
- html_url
- created_at
- updated_at
- permissions
- events
webhook-config:
title: Webhook Configuration
description: Configuration object of the webhook
type: object
properties:
url:
$ref: '#/components/schemas/webhook-config-url'
content_type:
$ref: '#/components/schemas/webhook-config-content-type'
secret:
$ref: '#/components/schemas/webhook-config-secret'
insecure_ssl:
$ref: '#/components/schemas/webhook-config-insecure-ssl'
empty-object_2:
title: Empty Object
description: An object without any properties.
type: object
additionalProperties: false
nullable-repository:
title: Repository
description: repository on GitHub.
type: object
properties:
id:
description: Unique identifier of the repository
example: 42
type: integer
format: int64
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
description: The name of the repository.
type: string
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
$ref: '#/components/schemas/nullable-license-simple_4'
forks:
type: integer
example: 42
permissions:
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
required:
- admin
- pull
- push
owner:
$ref: '#/components/schemas/simple-user_6'
private:
description: Whether the repository is private or public.
default: false
type: boolean
example: true
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
fork:
type: boolean
example: true
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example: git@github.com:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
language:
type: string
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
description: The default branch of the repository.
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
description: Whether this repository acts as a template that can be used to generate new repositories.
default: false
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
description: Whether issues are enabled.
default: true
type: boolean
example: true
has_projects:
description: Whether projects are enabled.
default: true
type: boolean
example: true
has_wiki:
description: Whether the wiki is enabled.
default: true
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
description: Whether downloads are enabled.
default: true
type: boolean
example: true
deprecated: true
has_discussions:
description: Whether discussions are enabled.
default: false
type: boolean
example: true
archived:
description: Whether the repository is archived.
default: false
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
default: public
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43Z'
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43Z'
allow_rebase_merge:
description: Whether to allow rebase merges for pull requests.
default: true
type: boolean
example: true
temp_clone_token:
type: string
allow_squash_merge:
description: Whether to allow squash merges for pull requests.
default: true
type: boolean
example: true
allow_auto_merge:
description: Whether to allow Auto-merge to be used on pull requests.
default: false
type: boolean
example: false
delete_branch_on_merge:
description: Whether to delete head branches when pull requests are merged
default: false
type: boolean
example: false
allow_update_branch:
description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
default: false
type: boolean
example: false
use_squash_pr_title_as_default:
type: boolean
description: Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: 'The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request''s title.
- `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).'
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: 'The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request''s body.
- `COMMIT_MESSAGES` - default to the branch''s commit messages.
- `BLANK` - default to a blank commit message.'
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: 'The default value for a merge commit title.
- `PR_TITLE` - default to the pull request''s title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).'
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: 'The default value for a merge commit message.
- `PR_TITLE` - default to the pull request''s title.
- `PR_BODY` - default to the pull request''s body.
- `BLANK` - default to a blank commit message.'
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
type: boolean
example: true
allow_forking:
description: Whether to allow forking this repo
type: boolean
web_commit_signoff_required:
description: Whether to require contributors to sign off on web-based commits
default: false
type: boolean
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_downloads
- has_issues
- has_projects
- has_wiki
- has_pages
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
repository-invitation:
title: Repository Invitation
description: Repository invitations let you manage who you collaborate with.
type: object
properties:
id:
description: Unique identifier of the repository invitation.
example: 42
type: integer
format: int64
repository:
$ref: '#/components/schemas/minimal-repository'
invitee:
$ref: '#/components/schemas/nullable-simple-user_5'
inviter:
$ref: '#/components/schemas/nullable-simple-user_5'
permissions:
description: The permission associated with the invitation.
example: read
type: string
enum:
- read
- write
- admin
- triage
- maintain
created_at:
type: string
format: date-time
example: '2016-06-13T14:52:50-05:00'
expired:
description: Whether or not the invitation has expired
type: boolean
example: true
url:
description: URL for the repository invitation
example: https://api.github.com/user/repository-invitations/1
type: string
html_url:
type: string
example: https://github.com/octocat/Hello-World/invitations
node_id:
type: string
example: '12345678'
required:
- id
- node_id
- permissions
- inviter
- invitee
- repository
- url
- html_url
- created_at
code-scanning-alert-instance:
type: object
properties:
ref:
$ref: '#/components/schemas/code-scanning-ref'
analysis_key:
$ref: '#/components/schemas/code-scanning-analysis-analysis-key'
environment:
$ref: '#/components/schemas/code-scanning-alert-environment'
category:
$ref: '#/components/schemas/code-scanning-analysis-category'
state:
$ref: '#/components/schemas/code-scanning-alert-state'
commit_sha:
type: string
example: abc123def456789012345678901234567890
message:
type: object
properties:
text:
type: string
location:
$ref: '#/components/schemas/code-scanning-alert-location'
html_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
classifications:
type: array
description: 'Classifications that have been applied to the file that triggered the alert.
For example identifying it as documentation, or a generated file.'
items:
$ref: '#/components/schemas/code-scanning-alert-classification'
code-scanning-alert-classification:
type: string
description: classification of the file. For example to identify it as generated.
enum:
- source
- generated
- test
- library
org-membership:
title: Org Membership
description: Org Membership
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/orgs/octocat/memberships/defunkt
state:
type: string
description: The state of the member in the organization. The `pending` state indicates the user has not yet accepted an invitation.
example: active
enum:
- active
- pending
role:
type: string
description: The user's membership type in the organization.
example: admin
enum:
- admin
- member
- billing_manager
organization_url:
type: string
format: uri
example: https://api.github.com/orgs/octocat
organization:
$ref: '#/components/schemas/organization-simple'
user:
$ref: '#/components/schemas/nullable-simple-user'
permissions:
type: object
properties:
can_create_repository:
type: boolean
required:
- can_create_repository
required:
- state
- role
- organization_url
- url
- organization
- user
deployment-branch-policy:
title: Deployment branch policy
description: Details of a deployment branch policy.
type: object
properties:
id:
description: The unique identifier of the branch policy.
type: integer
example: 361471
node_id:
type: string
example: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjE0NzE=
name:
description: The name pattern that branches must match in order to deploy to the environment.
type: string
example: release/*
commit-comment:
title: Commit Comment
description: Commit Comment
type: object
properties:
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
body:
type: string
example: Example body text
path:
type: string
example: src/index.js
position:
type: integer
example: 42
line:
type: integer
example: 42
commit_id:
type: string
example: '12345678'
user:
$ref: '#/components/schemas/nullable-simple-user_8'
created_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
updated_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
author_association:
$ref: '#/components/schemas/author-association'
reactions:
$ref: '#/components/schemas/reaction-rollup'
required:
- url
- html_url
- id
- node_id
- user
- position
- line
- path
- commit_id
- body
- author_association
- created_at
- updated_at
auto-merge:
title: Auto merge
description: The status of auto merging a pull request.
type: object
properties:
enabled_by:
$ref: '#/components/schemas/simple-user_5'
merge_method:
type: string
description: The merge method to use.
enum:
- merge
- squash
- rebase
example: merge
commit_title:
type: string
description: Title for the merge commit message.
example: Example Title
commit_message:
type: string
description: Commit message for the merge commit.
example: Example body text
required:
- enabled_by
- merge_method
- commit_title
- commit_message
deployment-branch-policy-settings:
type: object
description: The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.
properties:
protected_branches:
type: boolean
description: Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.
example: true
custom_branch_policies:
type: boolean
description: Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.
example: true
required:
- protected_branches
- custom_branch_policies
nullable-team-simple_3:
title: Team Simple
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
description: Unique identifier of the team
type: integer
example: 1
node_id:
type: string
example: MDQ6VGVhbTE=
url:
description: URL for the team
type: string
format: uri
example: https://api.github.com/organizations/1/team/1
members_url:
type: string
example: https://api.github.com/organizations/1/team/1/members{/member}
name:
description: Name of the team
type: string
example: Justice League
description:
description: Description of the team
type: string
example: great team.
permission:
description: Permission that the team will have for its repositories
type: string
example: admin
privacy:
description: The level of privacy this team should have
type: string
example: closed
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
repositories_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/1/repos
slug:
type: string
example: justice-league
ldap_dn:
description: Distinguished Name (DN) that team maps to within LDAP environment
example: uid=example,ou=users,dc=github,dc=com
type: string
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
public-user:
title: Public User
description: Public User
type: object
properties:
login:
type: string
example: octocat
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
avatar_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
gravatar_id:
type: string
nullable: true
example: '12345678'
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
followers_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
following_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
gists_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
starred_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
subscriptions_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
organizations_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
repos_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
events_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
received_events_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
type:
type: string
example: User
site_admin:
type: boolean
example: true
name:
type: string
nullable: true
example: octocat
company:
type: string
nullable: true
example: example_value
blog:
type: string
nullable: true
location:
type: string
nullable: true
email:
type: string
format: email
nullable: true
hireable:
type: boolean
nullable: true
bio:
type: string
nullable: true
twitter_username:
type: string
nullable: true
public_repos:
type: integer
public_gists:
type: integer
followers:
type: integer
following:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
plan:
type: object
properties:
collaborators:
type: integer
name:
type: string
space:
type: integer
private_repos:
type: integer
required:
- collaborators
- name
- space
- private_repos
suspended_at:
type: string
format: date-time
nullable: true
private_gists:
type: integer
example: 1
total_private_repos:
type: integer
example: 2
owned_private_repos:
type: integer
example: 2
disk_usage:
type: integer
example: 1
collaborators:
type: integer
example: 3
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
- bio
- blog
- company
- email
- followers
- following
- hireable
- location
- name
- public_gists
- public_repos
- created_at
- updated_at
additionalProperties: false
wait-timer:
type: integer
example: 30
description: 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).
repository_3:
title: Repository
description: repository on GitHub.
type: object
properties:
id:
description: Unique identifier of the repository
example: 42
type: integer
format: int64
node_id:
type: string
example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name:
description: The name of the repository.
type: string
example: Team Environment
full_name:
type: string
example: octocat/Hello-World
license:
$ref: '#/components/schemas/nullable-license-simple_4'
forks:
type: integer
example: 42
permissions:
type: object
properties:
admin:
type: boolean
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
required:
- admin
- pull
- push
owner:
$ref: '#/components/schemas/simple-user_6'
private:
description: Whether the repository is private or public.
default: false
type: boolean
example: true
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World
description:
type: string
example: This your first repo!
fork:
type: boolean
example: true
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
archive_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/contributors
deployments_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/deployments
downloads_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/downloads
events_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/events
forks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/forks
git_commits_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url:
type: string
example: git:github.com/octocat/Hello-World.git
issue_comment_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/languages
merges_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/merges
milestones_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url:
type: string
example: git@github.com:octocat/Hello-World.git
stargazers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/subscription
tags_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/tags
teams_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/teams
trees_url:
type: string
example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url:
type: string
example: https://github.com/octocat/Hello-World.git
mirror_url:
type: string
format: uri
example: git:git.example.com/octocat/Hello-World
hooks_url:
type: string
format: uri
example: http://api.github.com/repos/octocat/Hello-World/hooks
svn_url:
type: string
format: uri
example: https://svn.github.com/octocat/Hello-World
homepage:
type: string
format: uri
example: https://github.com
language:
type: string
forks_count:
type: integer
example: 9
stargazers_count:
type: integer
example: 80
watchers_count:
type: integer
example: 80
size:
description: The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0.
type: integer
example: 108
default_branch:
description: The default branch of the repository.
type: string
example: master
open_issues_count:
type: integer
example: 0
is_template:
description: Whether this repository acts as a template that can be used to generate new repositories.
default: false
type: boolean
example: true
topics:
type: array
items:
type: string
has_issues:
description: Whether issues are enabled.
default: true
type: boolean
example: true
has_projects:
description: Whether projects are enabled.
default: true
type: boolean
example: true
has_wiki:
description: Whether the wiki is enabled.
default: true
type: boolean
example: true
has_pages:
type: boolean
has_downloads:
description: Whether downloads are enabled.
default: true
type: boolean
example: true
deprecated: true
has_discussions:
description: Whether discussions are enabled.
default: false
type: boolean
example: true
archived:
description: Whether the repository is archived.
default: false
type: boolean
disabled:
type: boolean
description: Returns whether or not this repository disabled.
visibility:
description: 'The repository visibility: public, private, or internal.'
default: public
type: string
pushed_at:
type: string
format: date-time
example: '2011-01-26T19:06:43Z'
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:14:43Z'
allow_rebase_merge:
description: Whether to allow rebase merges for pull requests.
default: true
type: boolean
example: true
temp_clone_token:
type: string
allow_squash_merge:
description: Whether to allow squash merges for pull requests.
default: true
type: boolean
example: true
allow_auto_merge:
description: Whether to allow Auto-merge to be used on pull requests.
default: false
type: boolean
example: false
delete_branch_on_merge:
description: Whether to delete head branches when pull requests are merged
default: false
type: boolean
example: false
allow_update_branch:
description: Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging.
default: false
type: boolean
example: false
use_squash_pr_title_as_default:
type: boolean
description: Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead.
default: false
deprecated: true
squash_merge_commit_title:
type: string
enum:
- PR_TITLE
- COMMIT_OR_PR_TITLE
description: 'The default value for a squash merge commit title:
- `PR_TITLE` - default to the pull request''s title.
- `COMMIT_OR_PR_TITLE` - default to the commit''s title (if only one commit) or the pull request''s title (when more than one commit).'
squash_merge_commit_message:
type: string
enum:
- PR_BODY
- COMMIT_MESSAGES
- BLANK
description: 'The default value for a squash merge commit message:
- `PR_BODY` - default to the pull request''s body.
- `COMMIT_MESSAGES` - default to the branch''s commit messages.
- `BLANK` - default to a blank commit message.'
merge_commit_title:
type: string
enum:
- PR_TITLE
- MERGE_MESSAGE
description: 'The default value for a merge commit title.
- `PR_TITLE` - default to the pull request''s title.
- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).'
merge_commit_message:
type: string
enum:
- PR_BODY
- PR_TITLE
- BLANK
description: 'The default value for a merge commit message.
- `PR_TITLE` - default to the pull request''s title.
- `PR_BODY` - default to the pull request''s body.
- `BLANK` - default to a blank commit message.'
allow_merge_commit:
description: Whether to allow merge commits for pull requests.
default: true
type: boolean
example: true
allow_forking:
description: Whether to allow forking this repo
type: boolean
web_commit_signoff_required:
description: Whether to require contributors to sign off on web-based commits
default: false
type: boolean
open_issues:
type: integer
watchers:
type: integer
master_branch:
type: string
starred_at:
type: string
example: '"2020-07-09T00:17:42Z"'
anonymous_access_enabled:
type: boolean
description: Whether anonymous git access is enabled for this repository
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_downloads
- has_issues
- has_projects
- has_wiki
- has_pages
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
status-check-policy:
title: Status Check Policy
description: Status Check Policy
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict:
type: boolean
example: true
contexts:
type: array
example:
- continuous-integration/travis-ci
items:
type: string
checks:
type: array
items:
type: object
properties:
context:
type: string
example: continuous-integration/travis-ci
app_id:
type: integer
required:
- context
- app_id
contexts_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts
required:
- url
- contexts_url
- strict
- contexts
- checks
ldap-mapping-user:
title: Ldap Private User
description: Ldap Private User
type: object
properties:
ldap_dn:
type: string
example: example_value
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
name:
type: string
example: monalisa octocat
nullable: true
company:
type: string
example: GitHub
nullable: true
blog:
type: string
example: https://github.com/blog
nullable: true
location:
type: string
example: San Francisco
nullable: true
email:
type: string
format: email
example: octocat@github.com
nullable: true
hireable:
type: boolean
nullable: true
bio:
type: string
example: There once was...
nullable: true
twitter_username:
type: string
example: monalisa
nullable: true
public_repos:
type: integer
example: 2
public_gists:
type: integer
example: 1
followers:
type: integer
example: 20
following:
type: integer
example: 0
created_at:
type: string
format: date-time
example: '2008-01-14T04:33:35Z'
updated_at:
type: string
format: date-time
example: '2008-01-14T04:33:35Z'
private_gists:
type: integer
example: 81
total_private_repos:
type: integer
example: 100
owned_private_repos:
type: integer
example: 100
disk_usage:
type: integer
example: 10000
collaborators:
type: integer
example: 8
two_factor_authentication:
type: boolean
example: true
plan:
type: object
properties:
collaborators:
type: integer
name:
type: string
space:
type: integer
private_repos:
type: integer
required:
- collaborators
- name
- space
- private_repos
suspended_at:
type: string
format: date-time
nullable: true
business_plus:
type: boolean
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
- bio
- blog
- company
- email
- followers
- following
- hireable
- location
- name
- public_gists
- public_repos
- created_at
- updated_at
- collaborators
- disk_usage
- owned_private_repos
- private_gists
- total_private_repos
- two_factor_authentication
deployment-simple:
title: Deployment
description: deployment created as the result of an Actions check run from a workflow that references an environment
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/example/deployments/1
id:
description: Unique identifier of the deployment
example: 42
type: integer
node_id:
type: string
example: MDEwOkRlcGxveW1lbnQx
task:
description: Parameter to specify a task to execute
example: deploy
type: string
original_environment:
type: string
example: staging
environment:
description: Name for the target deployment environment.
example: production
type: string
description:
type: string
example: Deploy request from hubot
created_at:
type: string
format: date-time
example: '2012-07-20T01:19:13Z'
updated_at:
type: string
format: date-time
example: '2012-07-20T01:19:13Z'
statuses_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/example/deployments/1/statuses
repository_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/example
transient_environment:
description: 'Specifies if the given environment is will no longer exist at some point in the future. Default: false.'
example: true
type: boolean
production_environment:
description: 'Specifies if the given environment is one that end-users directly interact with. Default: false.'
example: true
type: boolean
performed_via_github_app:
$ref: '#/components/schemas/nullable-integration_3'
required:
- id
- node_id
- task
- environment
- description
- statuses_url
- repository_url
- url
- created_at
- updated_at
release:
title: Release
description: release.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
assets_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
upload_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
tarball_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
zipball_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
tag_name:
description: The name of the tag.
example: v1.0.0
type: string
target_commitish:
description: Specifies the commitish value that determines where the Git tag is created from.
example: master
type: string
name:
type: string
example: octocat
body:
type: string
example: Example body text
draft:
description: true to create a draft (unpublished) release, false to create a published one.
example: false
type: boolean
prerelease:
description: Whether to identify the release as a prerelease or a full release.
example: false
type: boolean
created_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
published_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
author:
$ref: '#/components/schemas/simple-user_6'
assets:
type: array
items:
$ref: '#/components/schemas/release-asset'
body_html:
type: string
example: Example body text
body_text:
type: string
example: Example body text
mentions_count:
type: integer
reactions:
$ref: '#/components/schemas/reaction-rollup'
required:
- assets_url
- upload_url
- tarball_url
- zipball_url
- created_at
- published_at
- draft
- id
- node_id
- author
- html_url
- name
- prerelease
- tag_name
- target_commitish
- assets
- url
secret-scanning-alert:
type: object
properties:
number:
$ref: '#/components/schemas/alert-number'
created_at:
$ref: '#/components/schemas/alert-created-at'
updated_at:
$ref: '#/components/schemas/nullable-alert-updated-at'
url:
$ref: '#/components/schemas/alert-url'
html_url:
$ref: '#/components/schemas/alert-html-url'
locations_url:
type: string
format: uri
description: The REST API URL of the code locations for this alert.
example: https://api.github.com/repos/octocat/Hello-World
state:
$ref: '#/components/schemas/secret-scanning-alert-state'
resolution:
$ref: '#/components/schemas/secret-scanning-alert-resolution'
resolved_at:
type: string
format: date-time
description: 'The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
example: '2026-04-17T12:00:00Z'
resolved_by:
$ref: '#/components/schemas/nullable-simple-user_8'
resolution_comment:
type: string
description: An optional comment to resolve an alert.
example: example_value
secret_type:
type: string
description: The type of secret that secret scanning detected.
example: User
secret_type_display_name:
type: string
description: 'User-friendly name for the detected secret, matching the `secret_type`.
For a list of built-in patterns, see "[Secret scanning patterns](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/secret-scanning-patterns#supported-secrets-for-advanced-security)."'
example: octocat
secret:
type: string
description: The secret that was detected.
example: example_value
push_protection_bypassed:
type: boolean
description: Whether push protection was bypassed for the detected secret.
example: true
push_protection_bypassed_by:
$ref: '#/components/schemas/nullable-simple-user_8'
push_protection_bypassed_at:
type: string
format: date-time
description: 'The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
example: '2026-04-17T12:00:00Z'
alert-dismissed-at:
type: string
description: 'The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
release-asset:
title: Release Asset
description: Data related to a release.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
browser_download_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
name:
description: The file name of the asset.
type: string
example: Team Environment
label:
type: string
example: Example Title
state:
description: State of the release asset.
type: string
enum:
- uploaded
- open
example: uploaded
content_type:
type: string
example: User
size:
type: integer
example: 42
download_count:
type: integer
example: 42
created_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
updated_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
uploader:
$ref: '#/components/schemas/nullable-simple-user_8'
required:
- id
- name
- content_type
- size
- state
- url
- node_id
- download_count
- label
- uploader
- browser_download_url
- created_at
- updated_at
validation-error:
title: Validation Error
description: Validation Error
type: object
required:
- message
- documentation_url
properties:
message:
type: string
example: Example body text
documentation_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
errors:
type: array
items:
type: object
required:
- code
properties:
resource:
type: string
field:
type: string
message:
type: string
code:
type: string
index:
type: integer
value:
oneOf:
- type: string
nullable: true
- type: integer
nullable: true
- type: array
nullable: true
items:
type: string
user-response:
type: object
required:
- schemas
- active
- emails
properties:
schemas:
type: array
description: The URIs that are used to indicate the namespaces of the SCIM schemas.
items:
type: string
enum:
- urn:ietf:params:scim:schemas:core:2.0:User
example:
- urn:ietf:params:scim:schemas:core:2.0:User
externalId:
type: string
description: A unique identifier for the resource as defined by the provisioning client.
example: E012345
nullable: true
active:
type: boolean
description: Whether the user active in the IdP.
example: true
userName:
type: string
description: The username for the user.
example: E012345
name:
$ref: '#/components/schemas/user-name-response'
displayName:
type: string
description: A human-readable name for the user.
example: Mona Lisa
nullable: true
emails:
$ref: '#/components/schemas/user-emails-response'
roles:
$ref: '#/components/schemas/user-role'
nullable-scoped-installation:
title: Scoped Installation
type: object
properties:
permissions:
$ref: '#/components/schemas/app-permissions'
repository_selection:
description: Describe whether all repositories have been selected or there's a selection involved
type: string
enum:
- all
- selected
example: all
single_file_name:
type: string
example: config.yaml
nullable: true
has_multiple_single_files:
type: boolean
example: true
single_file_paths:
type: array
items:
type: string
example:
- config.yml
- .github/issue_TEMPLATE.md
repositories_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
account:
$ref: '#/components/schemas/simple-user'
required:
- permissions
- repository_selection
- single_file_name
- repositories_url
- account
nullable: true
pull-request-review-comment:
title: Pull Request Review Comment
description: Pull Request Review Comments are comments on a portion of the Pull Request's diff.
type: object
properties:
url:
description: URL for the pull request review comment
example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
type: string
pull_request_review_id:
description: The ID of the pull request review to which the comment belongs.
type: integer
format: int64
example: 42
id:
description: The ID of the pull request review comment.
type: integer
format: int64
example: 1
node_id:
description: The node ID of the pull request review comment.
type: string
example: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw
diff_hunk:
description: The diff of the line that the comment refers to.
type: string
example: '@@ -16,33 +16,40 @@ public class Connection : IConnection...'
path:
description: The relative path of the file to which the comment applies.
example: config/database.yaml
type: string
position:
description: The line index in the diff to which the comment applies. This field is deprecated; use `line` instead.
example: 1
type: integer
original_position:
description: The index of the original line in the diff to which the comment applies. This field is deprecated; use `original_line` instead.
example: 4
type: integer
commit_id:
description: The SHA of the commit to which the comment applies.
example: 6dcb09b5b57875f334f61aebed695e2e4193db5e
type: string
original_commit_id:
description: The SHA of the original commit to which the comment applies.
example: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840
type: string
in_reply_to_id:
description: The comment ID to reply to.
example: 8
type: integer
user:
$ref: '#/components/schemas/simple-user_5'
body:
description: The text of the comment.
example: We should probably include a check for null values here.
type: string
created_at:
type: string
format: date-time
example: '2011-04-14T16:00:49Z'
updated_at:
type: string
format: date-time
example: '2011-04-14T16:00:49Z'
html_url:
description: HTML URL for the pull request review comment.
type: string
format: uri
example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
pull_request_url:
description: URL for the pull request that the review comment belongs to.
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/1
author_association:
$ref: '#/components/schemas/author-association'
_links:
type: object
properties:
self:
type: object
properties:
href:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
required:
- href
html:
type: object
properties:
href:
type: string
format: uri
example: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
required:
- href
pull_request:
type: object
properties:
href:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/1
required:
- href
required:
- self
- html
- pull_request
start_line:
type: integer
description: The first line of the range for a multi-line comment.
example: 2
original_start_line:
type: integer
description: The first line of the range for a multi-line comment.
example: 2
start_side:
type: string
description: The side of the first line of the range for a multi-line comment.
enum:
- LEFT
- RIGHT
default: RIGHT
line:
description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment
example: 2
type: integer
original_line:
description: The line of the blob to which the comment applies. The last line of the range for a multi-line comment
example: 2
type: integer
side:
description: The side of the diff to which the comment applies. The side of the last line of the range for a multi-line comment
enum:
- LEFT
- RIGHT
default: RIGHT
type: string
subject_type:
description: The level at which the comment is targeted, can be a diff line or a file.
type: string
enum:
- line
- file
reactions:
$ref: '#/components/schemas/reaction-rollup'
body_html:
type: string
example: '"comment body
"'
body_text:
type: string
example: '"comment body"'
required:
- url
- id
- node_id
- pull_request_review_id
- diff_hunk
- path
- commit_id
- original_commit_id
- user
- body
- created_at
- updated_at
- html_url
- pull_request_url
- author_association
- _links
code-scanning-analysis-tool-name:
type: string
description: The name of the tool used to generate the code scanning analysis.
nullable-milestone_3:
title: Milestone
description: collection of related issues and pull requests.
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id:
type: integer
example: 1002604
node_id:
type: string
example: MDk6TWlsZXN0b25lMTAwMjYwNA==
number:
description: The number of the milestone.
type: integer
example: 42
state:
description: The state of the milestone.
example: open
type: string
enum:
- open
- closed
default: open
title:
description: The title of the milestone.
example: v1.0
type: string
description:
type: string
example: Tracking milestone for version 1.0
creator:
$ref: '#/components/schemas/nullable-simple-user_7'
open_issues:
type: integer
example: 4
closed_issues:
type: integer
example: 8
created_at:
type: string
format: date-time
example: '2011-04-10T20:09:31Z'
updated_at:
type: string
format: date-time
example: '2014-03-03T18:58:10Z'
closed_at:
type: string
format: date-time
example: '2013-02-12T13:22:01Z'
due_on:
type: string
format: date-time
example: '2012-10-09T23:39:01Z'
required:
- closed_issues
- creator
- description
- due_on
- closed_at
- id
- node_id
- labels_url
- html_url
- number
- open_issues
- state
- title
- url
- created_at
- updated_at
validation-error-simple:
title: Validation Error Simple
description: Validation Error Simple
type: object
required:
- message
- documentation_url
properties:
message:
type: string
example: Example body text
documentation_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
errors:
type: array
items:
type: string
meta:
type: object
description: The metadata associated with the creation/updates to the user.
required:
- resourceType
properties:
resourceType:
type: string
description: A type of a resource
enum:
- User
- Group
example: User
created:
type: string
description: A date and time when the user was created.
example: '2022-03-27T19:59:26.000Z'
lastModified:
type: string
description: A data and time when the user was last modified.
example: '2022-03-27T19:59:26.000Z'
location:
type: string
description: A URL location of an object
example: example_value
check-suite-preference:
title: Check Suite Preference
description: Check suite configuration preferences for a repository.
type: object
required:
- preferences
- repository
properties:
preferences:
type: object
properties:
auto_trigger_checks:
type: array
items:
type: object
properties:
app_id:
type: integer
setting:
type: boolean
required:
- app_id
- setting
repository:
$ref: '#/components/schemas/minimal-repository_2'
secret-scanning-alert-resolution-comment:
description: An optional comment when closing an alert. Cannot be updated or deleted. Must be `null` when changing `state` to `open`.
type: string
deployment-reviewer-type:
type: string
description: The type of reviewer.
enum:
- User
- Team
example: User
nullable-simple-user_4:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
branch-restriction-policy:
title: Branch Restriction Policy
description: Branch Restriction Policy
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
users_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
teams_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
apps_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
users:
type: array
items:
type: object
properties:
login:
type: string
id:
type: integer
format: int64
node_id:
type: string
avatar_url:
type: string
gravatar_id:
type: string
url:
type: string
html_url:
type: string
followers_url:
type: string
following_url:
type: string
gists_url:
type: string
starred_url:
type: string
subscriptions_url:
type: string
organizations_url:
type: string
repos_url:
type: string
events_url:
type: string
received_events_url:
type: string
type:
type: string
site_admin:
type: boolean
teams:
type: array
items:
type: object
properties:
id:
type: integer
node_id:
type: string
url:
type: string
html_url:
type: string
name:
type: string
slug:
type: string
description:
type: string
privacy:
type: string
permission:
type: string
members_url:
type: string
repositories_url:
type: string
parent:
type: string
apps:
type: array
items:
type: object
properties:
id:
type: integer
slug:
type: string
node_id:
type: string
owner:
type: object
properties:
login:
type: string
id:
type: integer
node_id:
type: string
url:
type: string
repos_url:
type: string
events_url:
type: string
hooks_url:
type: string
issues_url:
type: string
members_url:
type: string
public_members_url:
type: string
avatar_url:
type: string
description:
type: string
gravatar_id:
type: string
example: '""'
html_url:
type: string
example: '"https://github.com/testorg-ea8ec76d71c3af4b"'
followers_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/followers"'
following_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/following{/other_user}"'
gists_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/gists{/gist_id}"'
starred_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/starred{/owner}{/repo}"'
subscriptions_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/subscriptions"'
organizations_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/orgs"'
received_events_url:
type: string
example: '"https://api.github.com/users/testorg-ea8ec76d71c3af4b/received_events"'
type:
type: string
example: '"Organization"'
site_admin:
type: boolean
example: false
name:
type: string
description:
type: string
external_url:
type: string
html_url:
type: string
created_at:
type: string
updated_at:
type: string
permissions:
type: object
properties:
metadata:
type: string
contents:
type: string
issues:
type: string
single_file:
type: string
events:
type: array
items:
type: string
required:
- url
- users_url
- teams_url
- apps_url
- users
- teams
- apps
pull-request:
type: object
title: Pull Request
description: 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 changes, discuss potential modifications, and even push follow-up commits if necessary.
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDExOlB1bGxSZXF1ZXN0MQ==
html_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/pull/1347
diff_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/pull/1347.diff
patch_url:
type: string
format: uri
example: https://github.com/octocat/Hello-World/pull/1347.patch
issue_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/issues/1347
commits_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
review_comments_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
review_comment_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}
comments_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
statuses_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
number:
description: Number uniquely identifying the pull request within its repository.
example: 42
type: integer
state:
description: State of this Pull Request. Either `open` or `closed`.
enum:
- open
- closed
example: open
type: string
locked:
type: boolean
example: true
title:
description: The title of the pull request.
example: Amazing new feature
type: string
user:
$ref: '#/components/schemas/simple-user_5'
body:
type: string
example: Please pull these awesome changes
labels:
type: array
items:
type: object
properties:
id:
type: integer
format: int64
node_id:
type: string
url:
type: string
name:
type: string
description:
type: string
color:
type: string
default:
type: boolean
required:
- id
- node_id
- url
- name
- description
- color
- default
milestone:
$ref: '#/components/schemas/nullable-milestone_3'
active_lock_reason:
type: string
example: too heated
created_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
updated_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
closed_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
merged_at:
type: string
format: date-time
example: '2011-01-26T19:01:12Z'
merge_commit_sha:
type: string
example: e5bd3914e2e596debea16f433f57875b5b90bcd6
assignee:
$ref: '#/components/schemas/nullable-simple-user_7'
assignees:
type: array
items:
$ref: '#/components/schemas/simple-user_5'
requested_reviewers:
type: array
items:
$ref: '#/components/schemas/simple-user_5'
requested_teams:
type: array
items:
$ref: '#/components/schemas/team-simple'
head:
type: object
properties:
label:
type: string
ref:
type: string
repo:
type: object
properties:
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
format: uri
deployments_url:
type: string
format: uri
description:
type: string
downloads_url:
type: string
format: uri
events_url:
type: string
format: uri
fork:
type: boolean
forks_url:
type: string
format: uri
full_name:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
hooks_url:
type: string
format: uri
html_url:
type: string
format: uri
id:
type: integer
node_id:
type: string
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
format: uri
merges_url:
type: string
format: uri
milestones_url:
type: string
name:
type: string
notifications_url:
type: string
owner:
type: object
properties:
avatar_url:
type: string
format: uri
events_url:
type: string
followers_url:
type: string
format: uri
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
format: uri
id:
type: integer
node_id:
type: string
login:
type: string
organizations_url:
type: string
format: uri
received_events_url:
type: string
format: uri
repos_url:
type: string
format: uri
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
format: uri
type:
type: string
url:
type: string
format: uri
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
private:
type: boolean
pulls_url:
type: string
releases_url:
type: string
stargazers_url:
type: string
format: uri
statuses_url:
type: string
subscribers_url:
type: string
format: uri
subscription_url:
type: string
format: uri
tags_url:
type: string
format: uri
teams_url:
type: string
format: uri
trees_url:
type: string
url:
type: string
format: uri
clone_url:
type: string
default_branch:
type: string
forks:
type: integer
forks_count:
type: integer
git_url:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_discussions:
type: boolean
homepage:
type: string
format: uri
language:
type: string
master_branch:
type: string
archived:
type: boolean
disabled:
type: boolean
visibility:
description: 'The repository visibility: public, private, or internal.'
type: string
mirror_url:
type: string
format: uri
open_issues:
type: integer
open_issues_count:
type: integer
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
required:
- admin
- pull
- push
temp_clone_token:
type: string
allow_merge_commit:
type: boolean
allow_squash_merge:
type: boolean
allow_rebase_merge:
type: boolean
license:
type: object
properties:
key:
type: string
name:
type: string
url:
type: string
format: uri
spdx_id:
type: string
node_id:
type: string
required:
- key
- name
- url
- spdx_id
- node_id
pushed_at:
type: string
format: date-time
size:
type: integer
ssh_url:
type: string
stargazers_count:
type: integer
svn_url:
type: string
format: uri
topics:
type: array
items:
type: string
watchers:
type: integer
watchers_count:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
allow_forking:
type: boolean
is_template:
type: boolean
web_commit_signoff_required:
type: boolean
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_downloads
- has_issues
- has_projects
- has_wiki
- has_pages
- has_discussions
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
sha:
type: string
user:
type: object
properties:
avatar_url:
type: string
format: uri
events_url:
type: string
followers_url:
type: string
format: uri
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
format: uri
id:
type: integer
format: int64
node_id:
type: string
login:
type: string
organizations_url:
type: string
format: uri
received_events_url:
type: string
format: uri
repos_url:
type: string
format: uri
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
format: uri
type:
type: string
url:
type: string
format: uri
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
required:
- label
- ref
- repo
- sha
- user
base:
type: object
properties:
label:
type: string
ref:
type: string
repo:
type: object
properties:
archive_url:
type: string
assignees_url:
type: string
blobs_url:
type: string
branches_url:
type: string
collaborators_url:
type: string
comments_url:
type: string
commits_url:
type: string
compare_url:
type: string
contents_url:
type: string
contributors_url:
type: string
format: uri
deployments_url:
type: string
format: uri
description:
type: string
downloads_url:
type: string
format: uri
events_url:
type: string
format: uri
fork:
type: boolean
forks_url:
type: string
format: uri
full_name:
type: string
git_commits_url:
type: string
git_refs_url:
type: string
git_tags_url:
type: string
hooks_url:
type: string
format: uri
html_url:
type: string
format: uri
id:
type: integer
is_template:
type: boolean
node_id:
type: string
issue_comment_url:
type: string
issue_events_url:
type: string
issues_url:
type: string
keys_url:
type: string
labels_url:
type: string
languages_url:
type: string
format: uri
merges_url:
type: string
format: uri
milestones_url:
type: string
name:
type: string
notifications_url:
type: string
owner:
type: object
properties:
avatar_url:
type: string
format: uri
events_url:
type: string
followers_url:
type: string
format: uri
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
format: uri
id:
type: integer
node_id:
type: string
login:
type: string
organizations_url:
type: string
format: uri
received_events_url:
type: string
format: uri
repos_url:
type: string
format: uri
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
format: uri
type:
type: string
url:
type: string
format: uri
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
private:
type: boolean
pulls_url:
type: string
releases_url:
type: string
stargazers_url:
type: string
format: uri
statuses_url:
type: string
subscribers_url:
type: string
format: uri
subscription_url:
type: string
format: uri
tags_url:
type: string
format: uri
teams_url:
type: string
format: uri
trees_url:
type: string
url:
type: string
format: uri
clone_url:
type: string
default_branch:
type: string
forks:
type: integer
forks_count:
type: integer
git_url:
type: string
has_downloads:
type: boolean
has_issues:
type: boolean
has_projects:
type: boolean
has_wiki:
type: boolean
has_pages:
type: boolean
has_discussions:
type: boolean
homepage:
type: string
format: uri
language:
type: string
master_branch:
type: string
archived:
type: boolean
disabled:
type: boolean
visibility:
description: 'The repository visibility: public, private, or internal.'
type: string
mirror_url:
type: string
format: uri
open_issues:
type: integer
open_issues_count:
type: integer
permissions:
type: object
properties:
admin:
type: boolean
maintain:
type: boolean
push:
type: boolean
triage:
type: boolean
pull:
type: boolean
required:
- admin
- pull
- push
temp_clone_token:
type: string
allow_merge_commit:
type: boolean
allow_squash_merge:
type: boolean
allow_rebase_merge:
type: boolean
license:
$ref: '#/components/schemas/nullable-license-simple_3'
pushed_at:
type: string
format: date-time
size:
type: integer
ssh_url:
type: string
stargazers_count:
type: integer
svn_url:
type: string
format: uri
topics:
type: array
items:
type: string
watchers:
type: integer
watchers_count:
type: integer
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
allow_forking:
type: boolean
web_commit_signoff_required:
type: boolean
required:
- archive_url
- assignees_url
- blobs_url
- branches_url
- collaborators_url
- comments_url
- commits_url
- compare_url
- contents_url
- contributors_url
- deployments_url
- description
- downloads_url
- events_url
- fork
- forks_url
- full_name
- git_commits_url
- git_refs_url
- git_tags_url
- hooks_url
- html_url
- id
- node_id
- issue_comment_url
- issue_events_url
- issues_url
- keys_url
- labels_url
- languages_url
- merges_url
- milestones_url
- name
- notifications_url
- owner
- private
- pulls_url
- releases_url
- stargazers_url
- statuses_url
- subscribers_url
- subscription_url
- tags_url
- teams_url
- trees_url
- url
- clone_url
- default_branch
- forks
- forks_count
- git_url
- has_downloads
- has_issues
- has_projects
- has_wiki
- has_pages
- has_discussions
- homepage
- language
- archived
- disabled
- mirror_url
- open_issues
- open_issues_count
- license
- pushed_at
- size
- ssh_url
- stargazers_count
- svn_url
- watchers
- watchers_count
- created_at
- updated_at
sha:
type: string
user:
type: object
properties:
avatar_url:
type: string
format: uri
events_url:
type: string
followers_url:
type: string
format: uri
following_url:
type: string
gists_url:
type: string
gravatar_id:
type: string
html_url:
type: string
format: uri
id:
type: integer
format: int64
node_id:
type: string
login:
type: string
organizations_url:
type: string
format: uri
received_events_url:
type: string
format: uri
repos_url:
type: string
format: uri
site_admin:
type: boolean
starred_url:
type: string
subscriptions_url:
type: string
format: uri
type:
type: string
url:
type: string
format: uri
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
required:
- label
- ref
- repo
- sha
- user
_links:
type: object
properties:
comments:
$ref: '#/components/schemas/link'
commits:
$ref: '#/components/schemas/link'
statuses:
$ref: '#/components/schemas/link'
html:
$ref: '#/components/schemas/link'
issue:
$ref: '#/components/schemas/link'
review_comments:
$ref: '#/components/schemas/link'
review_comment:
$ref: '#/components/schemas/link'
self:
$ref: '#/components/schemas/link'
required:
- comments
- commits
- statuses
- html
- issue
- review_comments
- review_comment
- self
author_association:
$ref: '#/components/schemas/author-association'
auto_merge:
$ref: '#/components/schemas/auto-merge'
draft:
description: Indicates whether or not the pull request is a draft.
example: false
type: boolean
merged:
type: boolean
mergeable:
type: boolean
example: true
rebaseable:
type: boolean
example: true
mergeable_state:
type: string
example: clean
merged_by:
$ref: '#/components/schemas/nullable-simple-user_7'
comments:
type: integer
example: 10
review_comments:
type: integer
example: 0
maintainer_can_modify:
description: Indicates whether maintainers can modify the pull request.
example: true
type: boolean
commits:
type: integer
example: 3
additions:
type: integer
example: 100
deletions:
type: integer
example: 3
changed_files:
type: integer
example: 5
required:
- _links
- assignee
- labels
- base
- body
- closed_at
- comments_url
- commits_url
- created_at
- diff_url
- head
- html_url
- id
- node_id
- issue_url
- merge_commit_sha
- merged_at
- milestone
- number
- patch_url
- review_comment_url
- review_comments_url
- statuses_url
- state
- locked
- title
- updated_at
- url
- user
- author_association
- auto_merge
- additions
- changed_files
- comments
- commits
- deletions
- mergeable
- mergeable_state
- merged
- maintainer_can_modify
- merged_by
- review_comments
hook:
title: Webhook
description: Webhooks for repositories.
type: object
properties:
type:
type: string
example: User
id:
description: Unique identifier of the webhook.
example: 42
type: integer
name:
description: The name of a valid service, use 'web' for a webhook.
example: web
type: string
active:
description: Determines whether the hook is actually triggered on pushes.
type: boolean
example: true
events:
description: 'Determines what events the hook is triggered for. Default: [''push''].'
type: array
items:
type: string
example:
- push
- pull_request
config:
$ref: '#/components/schemas/webhook-config'
updated_at:
type: string
format: date-time
example: '2011-09-06T20:39:23Z'
created_at:
type: string
format: date-time
example: '2011-09-06T17:26:27Z'
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1
test_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/test
ping_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/pings
deliveries_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/hooks/1/deliveries
last_response:
$ref: '#/components/schemas/hook-response'
required:
- id
- url
- type
- name
- active
- events
- config
- ping_url
- created_at
- updated_at
- last_response
- test_url
webhook-config-content-type:
type: string
description: The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.
example: '"json"'
simple-user_2:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
alert-number:
type: integer
description: The security alert number.
readOnly: true
pull-request-minimal:
title: Pull Request Minimal
type: object
properties:
id:
type: integer
format: int64
example: 42
number:
type: integer
example: 42
url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
head:
type: object
properties:
ref:
type: string
sha:
type: string
repo:
type: object
properties:
id:
type: integer
format: int64
url:
type: string
name:
type: string
required:
- id
- url
- name
required:
- ref
- sha
- repo
base:
type: object
properties:
ref:
type: string
sha:
type: string
repo:
type: object
properties:
id:
type: integer
format: int64
url:
type: string
name:
type: string
required:
- id
- url
- name
required:
- ref
- sha
- repo
required:
- id
- number
- url
- head
- base
team_2:
title: Team
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
name:
type: string
example: octocat
slug:
type: string
example: example_value
description:
type: string
example: This is an example repository
privacy:
type: string
example: example_value
permission:
type: string
example: example_value
permissions:
type: object
properties:
pull:
type: boolean
triage:
type: boolean
push:
type: boolean
maintain:
type: boolean
admin:
type: boolean
required:
- pull
- triage
- push
- maintain
- admin
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
members_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
repositories_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
parent:
$ref: '#/components/schemas/nullable-team-simple_3'
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
- parent
alert-instances-url:
type: string
description: The REST API URL for fetching the list of instances for an alert.
format: uri
readOnly: true
code-scanning-alert-state:
type: string
description: State of a code scanning alert.
enum:
- open
- dismissed
- fixed
organization-simple:
title: Organization Simple
description: A GitHub organization.
type: object
properties:
login:
type: string
example: github
id:
type: integer
example: 1
node_id:
type: string
example: MDEyOk9yZ2FuaXphdGlvbjE=
url:
type: string
format: uri
example: https://api.github.com/orgs/github
repos_url:
type: string
format: uri
example: https://api.github.com/orgs/github/repos
events_url:
type: string
format: uri
example: https://api.github.com/orgs/github/events
hooks_url:
type: string
example: https://api.github.com/orgs/github/hooks
issues_url:
type: string
example: https://api.github.com/orgs/github/issues
members_url:
type: string
example: https://api.github.com/orgs/github/members{/member}
public_members_url:
type: string
example: https://api.github.com/orgs/github/public_members{/member}
avatar_url:
type: string
example: https://github.com/images/error/octocat_happy.gif
description:
type: string
example: A great organization
nullable: true
required:
- login
- url
- id
- node_id
- repos_url
- events_url
- hooks_url
- issues_url
- members_url
- public_members_url
- avatar_url
- description
nullable-integration:
title: GitHub app
description: 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 come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.
type: object
properties:
id:
description: Unique identifier of the GitHub app
example: 37
type: integer
slug:
description: The slug name of the GitHub app
example: probot-owners
type: string
node_id:
type: string
example: MDExOkludGVncmF0aW9uMQ==
owner:
$ref: '#/components/schemas/nullable-simple-user'
name:
description: The name of the GitHub app
example: Probot Owners
type: string
description:
type: string
example: The description of the app.
nullable: true
external_url:
type: string
format: uri
example: https://example.com
html_url:
type: string
format: uri
example: https://github.com/apps/super-ci
created_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
updated_at:
type: string
format: date-time
example: '2017-07-08T16:18:44-04:00'
permissions:
description: The set of permissions for the GitHub app
type: object
properties:
issues:
type: string
checks:
type: string
metadata:
type: string
contents:
type: string
deployments:
type: string
additionalProperties:
type: string
example:
issues: read
deployments: write
events:
description: The list of events for the GitHub app
example:
- label
- deployment
type: array
items:
type: string
installations_count:
description: The number of installations associated with the GitHub app
example: 5
type: integer
client_id:
type: string
example: '"Iv1.25b5d1e65ffc4022"'
client_secret:
type: string
example: '"1d4b2097ac622ba702d19de498f005747a8b21d3"'
webhook_secret:
type: string
example: '"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b"'
nullable: true
pem:
type: string
example: '"--BEGIN RSA PRIVATE KEY--\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\n--END RSA PRIVATE KEY--\n"'
required:
- id
- node_id
- owner
- name
- description
- external_url
- html_url
- created_at
- updated_at
- permissions
- events
nullable: true
protected-branch:
title: Protected Branch
description: Branch protections protect branches
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
required_status_checks:
$ref: '#/components/schemas/status-check-policy'
required_pull_request_reviews:
type: object
properties:
url:
type: string
format: uri
dismiss_stale_reviews:
type: boolean
require_code_owner_reviews:
type: boolean
required_approving_review_count:
type: integer
require_last_push_approval:
description: Whether the most recent push must be approved by someone other than the person who pushed it.
type: boolean
default: false
dismissal_restrictions:
type: object
properties:
url:
type: string
format: uri
users_url:
type: string
format: uri
teams_url:
type: string
format: uri
users:
type: array
items:
$ref: '#/components/schemas/simple-user_2'
teams:
type: array
items:
$ref: '#/components/schemas/team'
apps:
type: array
items:
$ref: '#/components/schemas/integration'
required:
- url
- users_url
- teams_url
- users
- teams
bypass_pull_request_allowances:
type: object
properties:
users:
type: array
items:
$ref: '#/components/schemas/simple-user_2'
teams:
type: array
items:
$ref: '#/components/schemas/team'
apps:
type: array
items:
$ref: '#/components/schemas/integration'
required:
- users
- teams
required:
- url
required_signatures:
type: object
properties:
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_signatures
enabled:
type: boolean
example: true
required:
- url
- enabled
enforce_admins:
type: object
properties:
url:
type: string
format: uri
enabled:
type: boolean
additionalProperties: false
required:
- url
- enabled
required_linear_history:
type: object
properties:
enabled:
type: boolean
additionalProperties: false
required:
- enabled
allow_force_pushes:
type: object
properties:
enabled:
type: boolean
additionalProperties: false
required:
- enabled
allow_deletions:
type: object
properties:
enabled:
type: boolean
additionalProperties: false
required:
- enabled
restrictions:
$ref: '#/components/schemas/branch-restriction-policy'
required_conversation_resolution:
type: object
properties:
enabled:
type: boolean
additionalProperties: false
block_creations:
type: object
properties:
enabled:
type: boolean
additionalProperties: false
required:
- enabled
lock_branch:
type: object
description: Whether to set the branch as read-only. If this is true, users will not be able to push to the branch.
properties:
enabled:
default: false
type: boolean
additionalProperties: false
allow_fork_syncing:
type: object
description: Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow fork syncing. Set to `false` to prevent fork syncing.
properties:
enabled:
default: false
type: boolean
additionalProperties: false
required:
- url
code-scanning-alert:
type: object
properties:
number:
$ref: '#/components/schemas/alert-number'
created_at:
$ref: '#/components/schemas/alert-created-at'
updated_at:
$ref: '#/components/schemas/alert-updated-at'
url:
$ref: '#/components/schemas/alert-url'
html_url:
$ref: '#/components/schemas/alert-html-url'
instances_url:
$ref: '#/components/schemas/alert-instances-url'
state:
$ref: '#/components/schemas/code-scanning-alert-state'
fixed_at:
$ref: '#/components/schemas/alert-fixed-at'
dismissed_by:
$ref: '#/components/schemas/nullable-simple-user_3'
dismissed_at:
$ref: '#/components/schemas/alert-dismissed-at'
dismissed_reason:
$ref: '#/components/schemas/code-scanning-alert-dismissed-reason'
dismissed_comment:
$ref: '#/components/schemas/code-scanning-alert-dismissed-comment'
rule:
$ref: '#/components/schemas/code-scanning-alert-rule'
tool:
$ref: '#/components/schemas/code-scanning-analysis-tool'
most_recent_instance:
$ref: '#/components/schemas/code-scanning-alert-instance'
required:
- number
- created_at
- url
- html_url
- instances_url
- state
- dismissed_by
- dismissed_at
- dismissed_reason
- rule
- tool
- most_recent_instance
code-scanning-alert-dismissed-reason:
type: string
description: '**Required when the state is dismissed.** The reason for dismissing or closing the alert.'
enum:
- false positive
- won't fix
- used in tests
alert-created-at:
type: string
description: 'The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.'
format: date-time
readOnly: true
hook-response:
title: Hook Response
type: object
properties:
code:
type: integer
example: 42
status:
type: string
example: open
message:
type: string
example: Example body text
required:
- code
- status
- message
organization-custom-repository-role:
title: Organization Custom Repository Role
description: Custom repository roles created by organization owners
type: object
properties:
id:
description: The unique identifier of the custom role.
type: integer
example: 42
name:
description: The name of the custom role.
type: string
example: octocat
description:
description: A short description about who this role is for or what permissions it grants.
type: string
nullable: true
example: This is an example repository
base_role:
type: string
description: The system role from which this role inherits permissions.
enum:
- read
- triage
- write
- maintain
example: read
permissions:
description: A list of additional permissions included in this role.
type: array
items:
type: string
organization:
$ref: '#/components/schemas/simple-user'
created_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
updated_at:
type: string
format: date-time
example: '2026-04-17T12:00:00Z'
required:
- id
- name
- base_role
- permissions
- organization
- created_at
- updated_at
scim-error_2:
title: Scim Error
description: Scim Error
type: object
properties:
message:
type: string
nullable: true
example: Example body text
documentation_url:
type: string
nullable: true
example: https://api.github.com/repos/octocat/Hello-World
detail:
type: string
nullable: true
example: example_value
status:
type: integer
example: 42
scimType:
type: string
nullable: true
example: User
schemas:
type: array
items:
type: string
environment:
title: Environment
description: Details of a deployment environment
type: object
properties:
id:
description: The id of the environment.
example: 56780428
type: integer
node_id:
type: string
example: MDExOkVudmlyb25tZW50NTY3ODA0Mjg=
name:
description: The name of the environment.
example: staging
type: string
url:
type: string
example: https://api.github.com/repos/github/hello-world/environments/staging
html_url:
type: string
example: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging
created_at:
description: The time that the environment was created, in ISO 8601 format.
example: '2020-11-23T22:00:40Z'
format: date-time
type: string
updated_at:
description: The time that the environment was last updated, in ISO 8601 format.
example: '2020-11-23T22:00:40Z'
format: date-time
type: string
protection_rules:
type: array
description: Built-in deployment protection rules for the environment.
items:
anyOf:
- type: object
properties:
id:
type: integer
example: 3515
node_id:
type: string
example: MDQ6R2F0ZTM1MTU=
type:
type: string
example: wait_timer
wait_timer:
$ref: '#/components/schemas/wait-timer'
required:
- id
- node_id
- type
- type: object
properties:
id:
type: integer
example: 3755
node_id:
type: string
example: MDQ6R2F0ZTM3NTU=
type:
type: string
example: required_reviewers
reviewers:
type: array
description: The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.
items:
type: object
properties:
type:
$ref: '#/components/schemas/deployment-reviewer-type'
reviewer:
anyOf:
- $ref: '#/components/schemas/simple-user_6'
- $ref: '#/components/schemas/team_2'
required:
- id
- node_id
- type
- type: object
properties:
id:
type: integer
example: 3515
node_id:
type: string
example: MDQ6R2F0ZTM1MTU=
type:
type: string
example: branch_policy
required:
- id
- node_id
- type
deployment_branch_policy:
$ref: '#/components/schemas/deployment-branch-policy-settings'
required:
- id
- node_id
- name
- url
- html_url
- created_at
- updated_at
simple-user:
title: Simple User
description: A GitHub user.
type: object
properties:
name:
nullable: true
type: string
example: octocat
email:
nullable: true
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
nullable: true
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
user-name-response:
type: object
properties:
formatted:
type: string
description: The full name, including all middle names, titles, and suffixes as appropriate, formatted for display.
example: Ms. Mona Lisa Octocat
familyName:
type: string
description: The family name of the user.
example: Octocat
givenName:
type: string
description: The given name of the user.
example: Mona
middleName:
type: string
description: The middle name(s) of the user.
example: Lisa
gist-simple:
title: Gist Simple
description: Gist Simple
type: object
properties:
forks:
deprecated: true
nullable: true
type: array
items:
type: object
properties:
id:
type: string
url:
type: string
format: uri
user:
$ref: '#/components/schemas/public-user'
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
history:
deprecated: true
nullable: true
type: array
items:
$ref: '#/components/schemas/gist-history'
fork_of:
nullable: true
title: Gist
description: Gist
type: object
properties:
url:
type: string
format: uri
forks_url:
type: string
format: uri
commits_url:
type: string
format: uri
id:
type: string
node_id:
type: string
git_pull_url:
type: string
format: uri
git_push_url:
type: string
format: uri
html_url:
type: string
format: uri
files:
type: object
additionalProperties:
type: object
properties:
filename:
type: string
type:
type: string
language:
type: string
raw_url:
type: string
size:
type: integer
public:
type: boolean
created_at:
type: string
format: date-time
updated_at:
type: string
format: date-time
description:
type: string
nullable: true
comments:
type: integer
user:
$ref: '#/components/schemas/nullable-simple-user'
comments_url:
type: string
format: uri
owner:
$ref: '#/components/schemas/nullable-simple-user'
truncated:
type: boolean
forks:
type: array
items: {}
history:
type: array
items: {}
required:
- id
- node_id
- url
- forks_url
- commits_url
- git_pull_url
- git_push_url
- html_url
- comments_url
- public
- description
- comments
- user
- files
- created_at
- updated_at
url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
forks_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
commits_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
id:
type: string
example: '12345678'
node_id:
type: string
example: '12345678'
git_pull_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
git_push_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
files:
type: object
additionalProperties:
nullable: true
type: object
properties:
filename:
type: string
type:
type: string
language:
type: string
raw_url:
type: string
size:
type: integer
truncated:
type: boolean
content:
type: string
public:
type: boolean
example: true
created_at:
type: string
example: '2026-04-17T12:00:00Z'
updated_at:
type: string
example: '2026-04-17T12:00:00Z'
description:
type: string
nullable: true
example: This is an example repository
comments:
type: integer
example: 42
user:
type: string
nullable: true
example: example_value
comments_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
owner:
$ref: '#/components/schemas/simple-user'
truncated:
type: boolean
empty-object_5:
title: Empty Object
description: An object without any properties.
type: object
additionalProperties: false
code-scanning-alert-location:
type: object
description: Describe a region within a file for the alert.
properties:
path:
type: string
example: src/index.js
start_line:
type: integer
example: 42
end_line:
type: integer
example: 42
start_column:
type: integer
example: 42
end_column:
type: integer
example: 42
webhook-config-url:
type: string
description: The URL to which the payloads will be delivered.
example: https://example.com/webhook
format: uri
runner-groups-org:
type: object
properties:
id:
type: number
example: 42.5
name:
type: string
example: octocat
visibility:
type: string
example: public
default:
type: boolean
example: true
selected_repositories_url:
description: Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`
type: string
example: https://api.github.com/repos/octocat/Hello-World
runners_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
inherited:
type: boolean
example: true
inherited_allows_public_repositories:
type: boolean
example: true
allows_public_repositories:
type: boolean
example: true
workflow_restrictions_read_only:
description: If `true`, the `restricted_to_workflows` and `selected_workflows` fields cannot be modified.
type: boolean
default: false
example: true
restricted_to_workflows:
description: If `true`, the runner group will be restricted to running only the workflows specified in the `selected_workflows` array.
type: boolean
default: false
example: true
selected_workflows:
description: List of workflows the runner group should be allowed to run. This setting will be ignored unless `restricted_to_workflows` is set to `true`.
type: array
items:
type: string
description: Name of workflow the runner group should be allowed to run. Note that a ref, tag, or long SHA is required.
example: octo-org/octo-repo/.github/workflows/deploy.yaml@main
required:
- id
- name
- visibility
- default
- runners_url
- inherited
- allows_public_repositories
empty-object_4:
title: Empty Object
description: An object without any properties.
type: object
additionalProperties: false
code-scanning-alert-set-state:
description: Sets the state of the code scanning alert. You must provide `dismissed_reason` when you set the state to `dismissed`.
type: string
enum:
- open
- dismissed
empty-object:
title: Empty Object
description: An object without any properties.
type: object
properties: {}
additionalProperties: false
nullable-simple-user_7:
title: Simple User
description: GitHub user.
type: object
properties:
name:
type: string
example: octocat
email:
type: string
example: octocat@github.com
login:
type: string
example: octocat
id:
type: integer
format: int64
example: 1
node_id:
type: string
example: MDQ6VXNlcjE=
avatar_url:
type: string
format: uri
example: https://github.com/images/error/octocat_happy.gif
gravatar_id:
type: string
example: 41d064eb2195891e12d0413f63227ea7
url:
type: string
format: uri
example: https://api.github.com/users/octocat
html_url:
type: string
format: uri
example: https://github.com/octocat
followers_url:
type: string
format: uri
example: https://api.github.com/users/octocat/followers
following_url:
type: string
example: https://api.github.com/users/octocat/following{/other_user}
gists_url:
type: string
example: https://api.github.com/users/octocat/gists{/gist_id}
starred_url:
type: string
example: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url:
type: string
format: uri
example: https://api.github.com/users/octocat/subscriptions
organizations_url:
type: string
format: uri
example: https://api.github.com/users/octocat/orgs
repos_url:
type: string
format: uri
example: https://api.github.com/users/octocat/repos
events_url:
type: string
example: https://api.github.com/users/octocat/events{/privacy}
received_events_url:
type: string
format: uri
example: https://api.github.com/users/octocat/received_events
type:
type: string
example: User
site_admin:
type: boolean
example: true
starred_at:
type: string
example: '"2020-07-09T00:17:55Z"'
required:
- avatar_url
- events_url
- followers_url
- following_url
- gists_url
- gravatar_id
- html_url
- id
- node_id
- login
- organizations_url
- received_events_url
- repos_url
- site_admin
- starred_url
- subscriptions_url
- type
- url
nullable-team-simple:
title: Team Simple
description: Groups of organization members that gives permissions on specified repositories.
type: object
properties:
id:
description: Unique identifier of the team
type: integer
example: 1
node_id:
type: string
example: MDQ6VGVhbTE=
url:
description: URL for the team
type: string
format: uri
example: https://api.github.com/organizations/1/team/1
members_url:
type: string
example: https://api.github.com/organizations/1/team/1/members{/member}
name:
description: Name of the team
type: string
example: Justice League
description:
description: Description of the team
type: string
nullable: true
example: A great team.
permission:
description: Permission that the team will have for its repositories
type: string
example: admin
privacy:
description: The level of privacy this team should have
type: string
example: closed
html_url:
type: string
format: uri
example: https://github.com/orgs/rails/teams/core
repositories_url:
type: string
format: uri
example: https://api.github.com/organizations/1/team/1/repos
slug:
type: string
example: justice-league
ldap_dn:
description: Distinguished Name (DN) that team maps to within LDAP environment
example: uid=example,ou=users,dc=github,dc=com
type: string
required:
- id
- node_id
- url
- members_url
- name
- description
- permission
- html_url
- repositories_url
- slug
nullable: true
dependabot-alert-security-vulnerability:
type: object
description: Details pertaining to one vulnerable version range for the advisory.
readOnly: true
properties:
package:
$ref: '#/components/schemas/dependabot-alert-package'
severity:
type: string
description: The severity of the vulnerability.
readOnly: true
enum:
- low
- medium
- high
- critical
example: low
vulnerable_version_range:
type: string
description: Conditions that identify vulnerable versions of this vulnerability's package.
readOnly: true
example: example_value
first_patched_version:
type: object
description: Details pertaining to the package version that patches this vulnerability.
readOnly: true
properties:
identifier:
type: string
description: The package version that patches this vulnerability.
readOnly: true
required:
- identifier
additionalProperties: false
required:
- package
- severity
- vulnerable_version_range
- first_patched_version
additionalProperties: false
code-scanning-alert-dismissed-comment:
type: string
description: The dismissal comment associated with the dismissal of the alert.
maxLength: 280
nullable-license-simple:
title: License Simple
description: License Simple
type: object
properties:
key:
type: string
example: mit
name:
type: string
example: MIT License
url:
type: string
nullable: true
format: uri
example: https://api.github.com/licenses/mit
spdx_id:
type: string
nullable: true
example: MIT
node_id:
type: string
example: MDc6TGljZW5zZW1pdA==
html_url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
required:
- key
- name
- url
- spdx_id
- node_id
nullable: true
author-association:
title: author_association
type: string
example: OWNER
description: How the author is associated with the repository.
enum:
- COLLABORATOR
- CONTRIBUTOR
- FIRST_TIMER
- FIRST_TIME_CONTRIBUTOR
- MANNEQUIN
- MEMBER
- NONE
- OWNER
user-role:
type: array
description: The roles assigned to the user.
items:
type: object
required:
- value
properties:
display:
type: string
type:
type: string
value:
type: string
description: The role value representing a user role in GitHub.
enum:
- user
- 27d9891d-2c17-4f45-a262-781a0e55c80a
- guest_collaborator
- 1ebc4a02-e56c-43a6-92a5-02ee09b90824
- enterprise_owner
- 981df190-8801-4618-a08a-d91f6206c954
- ba4987ab-a1c3-412a-b58c-360fc407cb10
- billing_manager
- 0e338b8c-cc7f-498a-928d-ea3470d7e7e3
- e6be2762-e4ad-4108-b72d-1bbe884a0f91
example: user
primary:
type: boolean
description: Is the role a primary role for the user.
example: false
webhook-config-insecure-ssl:
oneOf:
- type: string
description: Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**
example: '"0"'
- type: number
code-scanning-ref:
type: string
description: 'The Git reference, formatted as `refs/pull//merge`, `refs/pull//head`,
`refs/heads/` or simply ``.'
alert-url:
type: string
description: The REST API URL of the alert resource.
format: uri
readOnly: true
ldap-mapping-team:
type: object
properties:
ldap_dn:
type: string
example: example_value
id:
type: integer
example: 42
node_id:
type: string
example: '12345678'
url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
html_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
name:
type: string
example: octocat
slug:
type: string
example: example_value
description:
type: string
nullable: true
example: This is an example repository
privacy:
type: string
example: example_value
permission:
type: string
example: example_value
members_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
repositories_url:
type: string
example: https://api.github.com/repos/octocat/Hello-World
parent:
nullable: true
example: example_value
git-ref:
title: Git Reference
description: Git references within a repository
type: object
properties:
ref:
type: string
example: main
node_id:
type: string
example: '12345678'
url:
type: string
format: uri
example: https://api.github.com/repos/octocat/Hello-World
object:
type: object
properties:
type:
type: string
sha:
description: SHA for the reference
example: 7638417db6d59f3c431d3e1f261cc637155684cd
type: string
minLength: 40
maxLength: 40
url:
type: string
format: uri
required:
- type
- sha
- url
required:
- ref
- node_id
- url
- object
examples:
file-commit-example-for-updating-a-file:
value:
content:
name: hello.txt
path: notes/hello.txt
sha: a56507ed892d05a37c6d6128c260937ea4d287bd
size: 9
url: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt
html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt
git_url: https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd
download_url: https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt
type: file
_links:
self: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt
git: https://api.github.com/repos/octocat/Hello-World/git/blobs/a56507ed892d05a37c6d6128c260937ea4d287bd
html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt
commit:
sha: 18a43cd8e1e3a79c786e3d808a73d23b6d212b16
node_id: MDY6Q29tbWl0MThhNDNjZDhlMWUzYTc5Yzc4NmUzZDgwOGE3M2QyM2I2ZDIxMmIxNg==
url: https://api.github.com/repos/octocat/Hello-World/git/commits/18a43cd8e1e3a79c786e3d808a73d23b6d212b16
html_url: https://github.com/octocat/Hello-World/git/commit/18a43cd8e1e3a79c786e3d808a73d23b6d212b16
author:
date: '2014-11-07T22:01:45Z'
name: Monalisa Octocat
email: octocat@github.com
committer:
date: '2014-11-07T22:01:45Z'
name: Monalisa Octocat
email: octocat@github.com
message: my commit message
tree:
url: https://api.github.com/repos/octocat/Hello-World/git/trees/9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f
sha: 9a21f8e2018f42ffcf369b24d2cd20bc25c9e66f
parents:
- url: https://api.github.com/repos/octocat/Hello-World/git/commits/da5a433788da5c255edad7979b328b67d79f53f6
html_url: https://github.com/octocat/Hello-World/git/commit/da5a433788da5c255edad7979b328b67d79f53f6
sha: da5a433788da5c255edad7979b328b67d79f53f6
verification:
verified: false
reason: unsigned
signature: ''
payload: ''
organization-custom-repository-role-example:
value:
id: 8030
name: Security Engineer
description: Able to contribute code and maintain the security pipeline
base_role: maintain
permissions:
- delete_alerts_code_scanning
organization:
login: github
id: 1
node_id: MDEyOk9yZ2FuaXphdGlvbjE=
url: https://api.github.com/orgs/github
repos_url: https://api.github.com/orgs/github/repos
events_url: https://api.github.com/orgs/github/events
hooks_url: https://api.github.com/orgs/github/hooks
issues_url: https://api.github.com/orgs/github/issues
members_url: https://api.github.com/orgs/github/members{/member}
public_members_url: https://api.github.com/orgs/github/public_members{/member}
avatar_url: https://github.com/images/error/octocat_happy.gif
description: A great organization
created_at: '2022-07-04T22:19:11Z'
updated_at: '2022-07-04T22:20:11Z'
release-asset:
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
id: 1
node_id: MDEyOlJlbGVhc2VBc3NldDE=
name: example.zip
label: short description
state: uploaded
content_type: application/zip
size: 1024
download_count: 42
created_at: '2013-02-27T19:35:32Z'
updated_at: '2013-02-27T19:35:32Z'
uploader:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
ldap-mapping-team:
value:
ldap_dn: cn=Enterprise Ops,ou=teams,dc=github,dc=com
id: 1
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: A great team.
privacy: closed
notification_setting: notifications_enabled
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
parent: null
team-discussion-2:
value:
author:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
body: Hi! This is an area for us to collaborate as a team.
body_html: Hi! This is an area for us to collaborate as a team
body_version: 0d495416a700fb06133c612575d92bfb
comments_count: 1
comments_url: https://api.github.com/teams/2343027/discussions/1/comments
created_at: '2018-01-25T18:56:31Z'
last_edited_at: '2018-01-26T18:22:20Z'
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1
node_id: MDE0OlRlYW1EaXNjdXNzaW9uMQ==
number: 1
pinned: false
private: false
team_url: https://api.github.com/teams/2343027
title: Welcome to our first team post
updated_at: '2018-01-26T18:22:20Z'
url: https://api.github.com/teams/2343027/discussions/1
reactions:
url: https://api.github.com/teams/2343027/discussions/1/reactions
total_count: 5
'+1': 3
'-1': 1
laugh: 0
confused: 0
heart: 1
hooray: 0
eyes: 1
rocket: 1
external-group:
value:
group_id: '123'
group_name: Octocat admins
updated_at: '2021-01-24T11:31:04-06:00'
teams:
- team_id: 1
team_name: team-test
- team_id: 2
team_name: team-test2
members:
- member_id: 1
member_login: mona-lisa_eocsaxrs
member_name: Mona Lisa
member_email: mona_lisa@github.com
- member_id: 2
member_login: octo-lisa_eocsaxrs
member_name: Octo Lisa
member_email: octo_lisa@github.com
org-pre-receive-hook-2:
value:
id: 42
name: Check Commits
enforcement: enabled
configuration_url: https://github.example.com/api/v3/orgs/octocat/pre-receive-hooks/42
allow_downstream_configuration: false
dependabot-alert-dismissed:
value:
number: 2
state: dismissed
dependency:
package:
ecosystem: pip
name: django
manifest_path: path/to/requirements.txt
scope: runtime
security_advisory:
ghsa_id: GHSA-rf4j-j272-fj86
cve_id: CVE-2018-6188
summary: Django allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive
description: django.contrib.auth.forms.AuthenticationForm in Django 2.0 before 2.0.2, and 1.11.8 and 1.11.9, allows remote attackers to obtain potentially sensitive information by leveraging data exposure from the confirm_login_allowed() method, as demonstrated by discovering whether a user account is inactive.
vulnerabilities:
- package:
ecosystem: pip
name: django
severity: high
vulnerable_version_range: '>= 2.0.0, < 2.0.2'
first_patched_version:
identifier: 2.0.2
- package:
ecosystem: pip
name: django
severity: high
vulnerable_version_range: '>= 1.11.8, < 1.11.10'
first_patched_version:
identifier: 1.11.10
severity: high
cvss:
vector_string: CVSS:3.0/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:N
score: 7.5
cwes:
- cwe_id: CWE-200
name: Exposure of Sensitive Information to an Unauthorized Actor
identifiers:
- type: GHSA
value: GHSA-rf4j-j272-fj86
- type: CVE
value: CVE-2018-6188
references:
- url: https://nvd.nist.gov/vuln/detail/CVE-2018-6188
- url: https://github.com/advisories/GHSA-rf4j-j272-fj86
- url: https://usn.ubuntu.com/3559-1/
- url: https://www.djangoproject.com/weblog/2018/feb/01/security-releases/
- url: http://www.securitytracker.com/id/1040422
published_at: '2018-10-03T21:13:54Z'
updated_at: '2022-04-26T18:35:37Z'
withdrawn_at: '2022-04-26T18:35:37Z'
security_vulnerability:
package:
ecosystem: pip
name: django
severity: high
vulnerable_version_range: '>= 2.0.0, < 2.0.2'
first_patched_version:
identifier: 2.0.2
url: https://api.github.com/repos/octocat/hello-world/dependabot/alerts/2
html_url: https://github.com/octocat/hello-world/security/dependabot/2
created_at: '2022-06-15T07:43:03Z'
updated_at: '2022-08-23T14:29:47Z'
dismissed_at: '2022-08-23T14:29:47Z'
dismissed_by:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
dismissed_reason: tolerable_risk
dismissed_comment: This alert is accurate but we use a sanitizer.
fixed_at: '2020-02-14T12:29:18Z'
issue-comment:
value:
id: 1
node_id: MDEyOklzc3VlQ29tbWVudDE=
url: https://api.github.com/repos/octocat/Hello-World/issues/comments/1
html_url: https://github.com/octocat/Hello-World/issues/1347#issuecomment-1
body: Me too
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
created_at: '2011-04-14T16:00:49Z'
updated_at: '2011-04-14T16:00:49Z'
issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347
author_association: COLLABORATOR
authorization-2:
value:
id: 1
url: https://api.github.com/authorizations/1
scopes:
- public_repo
token: ghu_16C7e42F292c6912E7710c838347Ae178B4a
token_last_eight: Ae178B4a
hashed_token: 25f94a2a5c7fbaf499c665bc73d67c1c87e496da8985131633ee0a95819db2e8
app:
url: http://my-github-app.com
name: my github app
client_id: abcde12345fghij67890
note: optional note
note_url: http://optional/note/url
updated_at: '2011-09-06T20:39:23Z'
created_at: '2011-09-06T17:26:27Z'
expires_at: '2011-10-06T17:26:27Z'
fingerprint: jklmnop12345678
repository-pre-receive-hook-2:
value:
id: 42
name: Check Commits
enforcement: enabled
configuration_url: https://github.example.com/api/v3/repos/octocat/hello-world/pre-receive-hooks/42
gist:
value:
url: https://api.github.com/gists/2decf6c462d9b4418f2
forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks
commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits
id: 2decf6c462d9b4418f2
node_id: G_kwDOBhHyLdZDliNDQxOGYy
git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git
git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git
html_url: https://gist.github.com/2decf6c462d9b4418f2
files:
README.md:
filename: README.md
type: text/markdown
language: Markdown
raw_url: https://gist.githubusercontent.com/monalisa/2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/README.md
size: 23
truncated: false
content: Hello world from GitHub
public: true
created_at: '2022-09-20T12:11:58Z'
updated_at: '2022-09-21T10:28:06Z'
description: An updated gist description.
comments: 0
user: null
comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments
owner:
login: monalisa
id: 104456405
node_id: U_kgDOBhHyLQ
avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
forks: []
history:
- user:
login: monalisa
id: 104456405
node_id: U_kgyLQ
avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
version: 468aac8caed5f0c3b859b8286968
committed_at: '2022-09-21T10:28:06Z'
change_status:
total: 2
additions: 1
deletions: 1
url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968
truncated: false
scim-enterprise-group:
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:Group
id: abcd27f8-a9aa-11ea-8221-f59b2be9cccc
externalId: 8aa1a0c0-c4c3-4bc0-b4a5-2ef676900159
displayName: Engineering
members:
- value: 879db59-3bdf-4490-ad68-ab880a2694745
$+ref: https://api.github.localhost/scim/v2/Users/879db59-3bdf-4490-ad68-ab880a2694745
displayName: User 1
- value: 0db508eb-91e2-46e4-809c-30dcbda0c685
$+ref: https://api.github.localhost/scim/v2/Users/0db508eb-91e2-46e4-809c-30dcbda0c685
displayName: User 2
meta:
resourceType: Group
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Groups/927fa2c08dcb4a7fae9e
check-suite-preference:
value:
preferences:
auto_trigger_checks:
- app_id: 2
setting: true
- app_id: 4
setting: false
repository:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World.git
mirror_url: git:git.example.com/octocat/Hello-World
hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks
svn_url: https://svn.github.com/octocat/Hello-World
homepage: https://github.com
language: EN
forks_count: 9
stargazers_count: 80
watchers_count: 80
size: 108
default_branch: master
open_issues_count: 0
is_template: false
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
archived: false
disabled: false
visibility: public
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
template_repository:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World-Template
full_name: octocat/Hello-World-Template
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World-Template
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World-Template
archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads
events_url: https://api.github.com/repos/octocat/Hello-World-Template/events
forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World-Template.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages
merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}
ssh_url: git@github.com:octocat/Hello-World-Template.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags
teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams
trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World-Template.git
mirror_url: git:git.example.com/octocat/Hello-World-Template
hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks
svn_url: https://svn.github.com/octocat/Hello-World-Template
homepage: https://github.com
language: EN
forks: 9
forks_count: 9
stargazers_count: 80
watchers_count: 80
watchers: 80
size: 108
default_branch: master
open_issues: 0
open_issues_count: 0
is_template: true
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
html_url: https://api.github.com/licenses/mit
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
archived: false
disabled: false
visibility: public
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
allow_rebase_merge: true
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_auto_merge: false
delete_branch_on_merge: true
allow_merge_commit: true
subscribers_count: 42
network_count: 0
code-scanning-default-setup-update-response:
value:
run_id: 42
run_url: https://api.github.com/repos/octoorg/octocat/actions/runs/42
label-2:
value:
id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
url: 'https://api.github.com/repos/octocat/Hello-World/labels/bug%20:bug:'
name: 'bug :bug:'
description: Small bug fix required
color: b01f26
default: true
runner-group:
value:
id: 2
name: octo-runner-group
visibility: selected
default: false
selected_repositories_url: https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories
runners_url: https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners
inherited: false
allows_public_repositories: true
restricted_to_workflows: true
selected_workflows:
- octo-org/octo-repo/.github/workflows/deploy.yaml@refs/heads/main
workflow_restrictions_read_only: false
branch-protection-update:
value:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection
required_status_checks:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks
strict: true
contexts:
- continuous-integration/travis-ci
contexts_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_status_checks/contexts
checks:
- context: continuous-integration/travis-ci
app_id: 1
restrictions:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions
users_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/users
teams_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/teams
apps_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/restrictions/apps
users: []
teams: []
apps: []
required_pull_request_reviews:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_pull_request_reviews
dismiss_stale_reviews: true
require_code_owner_reviews: true
required_approving_review_count: 2
require_last_push_approval: true
dismissal_restrictions:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions
users_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/users
teams_url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/dismissal_restrictions/teams
users: []
teams: []
apps: []
required_signatures:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/required_signatures
enabled: false
enforce_admins:
url: https://api.github.com/repos/octocat/hello-world/branches/main/protection/enforce_admins
enabled: true
required_linear_history:
enabled: true
allow_force_pushes:
enabled: true
allow_deletions:
enabled: true
block_creations:
enabled: true
required_conversation_resolution:
enabled: true
lock_branch:
enabled: true
allow_fork_syncing:
enabled: true
git-ref:
value:
ref: refs/heads/featureA
node_id: MDM6UmVmcmVmcy9oZWFkcy9mZWF0dXJlQQ==
url: https://api.github.com/repos/octocat/Hello-World/git/refs/heads/featureA
object:
type: commit
sha: aa218f56b14c9653891f9e74264a383fa43fefbd
url: https://api.github.com/repos/octocat/Hello-World/git/commits/aa218f56b14c9653891f9e74264a383fa43fefbd
commit-comment-2:
value:
html_url: https://github.com/octocat/Hello-World/commit/6dcb09b5b57875f334f61aebed695e2e4193db5e#commitcomment-1
url: https://api.github.com/repos/octocat/Hello-World/comments/1
id: 1
node_id: MDEzOkNvbW1pdENvbW1lbnQx
body: Nice change
path: file1.txt
position: 4
line: 14
commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e
author_association: COLLABORATOR
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
created_at: '2011-04-14T16:00:49Z'
updated_at: '2011-04-14T16:00:49Z'
code-scanning-default-setup-update:
value:
state: configured
protected-branch-pull-request-review:
value:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_pull_request_reviews
dismissal_restrictions:
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions
users_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/users
teams_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/dismissal_restrictions/teams
users:
- login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
teams:
- id: 1
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: great team.
privacy: closed
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
parent:
id: 2
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: great team.
privacy: closed
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
apps:
- id: 1
slug: octoapp
node_id: MDExOkludGVncmF0aW9uMQ==
owner:
login: github
id: 1
type: User
node_id: MDEyOk9yZ2FuaXphdGlvbjE=
url: https://api.github.com/orgs/github
repos_url: https://api.github.com/orgs/github/repos
events_url: https://api.github.com/orgs/github/events
hooks_url: https://api.github.com/orgs/github/hooks
issues_url: https://api.github.com/orgs/github/issues
members_url: https://api.github.com/orgs/github/members{/member}
public_members_url: https://api.github.com/orgs/github/public_members{/member}
followers_url: https://api.github.com/orgs/github/followers
following_url: https://api.github.com/orgs/github/following
avatar_url: https://github.com/images/error/octocat_happy.gif
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
description: great organization
gravatar_id: ''
html_url: https://github.com/apps/octoapp
organizations_url: https://api.github.com/users/octocat/orgs
received_events_url: https://api.github.com/users/octocat/received_events
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
site_admin: false
name: Octocat App
description: ''
external_url: https://example.com
html_url: https://github.com/apps/octoapp
created_at: '2017-07-08T16:18:44-04:00'
updated_at: '2017-07-08T16:18:44-04:00'
permissions:
metadata: read
contents: read
issues: write
single_file: write
events:
- push
- pull_request
dismiss_stale_reviews: true
require_code_owner_reviews: true
required_approving_review_count: 2
require_last_push_approval: true
deployment-branch-policy-wildcard:
value:
id: 364662
node_id: MDE2OkdhdGVCcmFuY2hQb2xpY3kzNjQ2NjI=
name: release/*
environment:
value:
id: 161088068
node_id: MDExOkVudmlyb25tZW50MTYxMDg4MDY4
name: staging
url: https://api.github.com/repos/github/hello-world/environments/staging
html_url: https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging
created_at: '2020-11-23T22:00:40Z'
updated_at: '2020-11-23T22:00:40Z'
protection_rules:
- id: 3736
node_id: MDQ6R2F0ZTM3MzY=
type: wait_timer
wait_timer: 30
- id: 3755
node_id: MDQ6R2F0ZTM3NTU=
type: required_reviewers
reviewers:
- type: User
reviewer:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- type: Team
reviewer:
id: 1
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: great team.
privacy: closed
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
parent:
id: 1
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: great team.
privacy: closed
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
- id: 3756
node_id: MDQ6R2F0ZTM3NTY=
type: branch_policy
deployment_branch_policy:
protected_branches: false
custom_branch_policies: true
code-scanning-alert-dismissed:
value:
number: 42
created_at: '2020-08-25T21:28:36Z'
url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42
html_url: https://github.com/octocat/hello-world/code-scanning/42
state: dismissed
fixed_at: '2018-05-04T01:14:52Z'
dismissed_by:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
dismissed_at: '2020-09-02T22:34:56Z'
dismissed_reason: false positive
dismissed_comment: This alert is not actually correct, because there's a sanitizer included in the library.
rule:
id: js/zipslip
severity: error
security_severity_level: high
description: Arbitrary file write during zip extraction ("Zip Slip")
name: js/zipslip
full_description: Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.
tags:
- security
- external/cwe/cwe-022
help: '# Arbitrary file write during zip extraction ("Zip Slip")\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...'
help_uri: https://codeql.github.com/
tool:
name: CodeQL
guid: 326aa09f-9af8-13cf-9851-3d0e5183ec38
version: 2.4.0
most_recent_instance:
ref: refs/heads/main
analysis_key: .github/workflows/codeql-analysis.yml:CodeQL-Build
category: .github/workflows/codeql-analysis.yml:CodeQL-Build
environment: '{}'
state: dismissed
commit_sha: 39406e42cb832f683daa691dd652a8dc36ee8930
message:
text: This path depends on a user-provided value.
location:
path: spec-main/api-session-spec.ts
start_line: 917
end_line: 917
start_column: 7
end_column: 18
classifications:
- test
instances_url: https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
ldap-mapping-user:
value:
ldap_dn: uid=asdf,ou=users,dc=github,dc=com
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
name: monalisa octocat
company: GitHub
blog: https://github.com/blog
location: San Francisco
email: octocat@github.com
hireable: false
bio: There once was...
twitter_username: monatheoctocat
public_repos: 2
public_gists: 1
followers: 20
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
private_gists: 81
total_private_repos: 100
owned_private_repos: 100
disk_usage: 10000
collaborators: 8
two_factor_authentication: true
plan:
name: Medium
space: 400
private_repos: 20
collaborators: 0
repository-invitation:
value:
id: 1
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
repository:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
hooks_url: http://api.github.com/repos/octocat/Hello-World/hooks
invitee:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
inviter:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
permissions: write
created_at: '2016-06-13T14:52:50-05:00'
expired: false
url: https://api.github.com/user/repository_invitations/1296269
html_url: https://github.com/octocat/Hello-World/invitations
hook:
value:
type: Repository
id: 12345678
name: web
active: true
events:
- push
- pull_request
config:
content_type: json
insecure_ssl: '0'
url: https://example.com/webhook
updated_at: '2019-06-03T00:57:16Z'
created_at: '2019-06-03T00:57:16Z'
url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678
test_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/test
ping_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/pings
deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries
last_response:
code: 1
status: unused
message: ''
project-3:
value:
owner_url: https://api.github.com/repos/api-playground/projects-test
url: https://api.github.com/projects/1002604
html_url: https://github.com/api-playground/projects-test/projects/1
columns_url: https://api.github.com/projects/1002604/columns
id: 1002604
node_id: MDc6UHJvamVjdDEwMDI2MDQ=
name: Projects Documentation
body: Developer documentation project for the developer site.
number: 1
state: open
creator:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
created_at: '2011-04-10T20:09:31Z'
updated_at: '2014-03-03T18:58:10Z'
secret-scanning-alert-resolved:
value:
number: 42
created_at: '2020-11-06T18:18:30Z'
url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42
html_url: https://github.com/owner/private-repo/security/secret-scanning/42
locations_url: https://api.github.com/repos/owner/private-repo/secret-scanning/alerts/42/locations
state: resolved
resolution: used_in_tests
resolved_at: '2020-11-16T22:42:07Z'
resolved_by:
login: monalisa
id: 2
node_id: MDQ6VXNlcjI=
avatar_url: https://alambic.github.com/avatars/u/2?
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
secret_type: mailchimp_api_key
secret_type_display_name: Mailchimp API Key
secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2
push_protection_bypassed: false
resolution_comment: Example comment
file-commit-example-for-creating-a-file:
value:
content:
name: hello.txt
path: notes/hello.txt
sha: 95b966ae1c166bd92f8ae7d1c313e738c731dfc3
size: 9
url: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt
html_url: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt
git_url: https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3
download_url: https://raw.githubusercontent.com/octocat/HelloWorld/master/notes/hello.txt
type: file
_links:
self: https://api.github.com/repos/octocat/Hello-World/contents/notes/hello.txt
git: https://api.github.com/repos/octocat/Hello-World/git/blobs/95b966ae1c166bd92f8ae7d1c313e738c731dfc3
html: https://github.com/octocat/Hello-World/blob/master/notes/hello.txt
commit:
sha: 7638417db6d59f3c431d3e1f261cc637155684cd
node_id: MDY6Q29tbWl0NzYzODQxN2RiNmQ1OWYzYzQzMWQzZTFmMjYxY2M2MzcxNTU2ODRjZA==
url: https://api.github.com/repos/octocat/Hello-World/git/commits/7638417db6d59f3c431d3e1f261cc637155684cd
html_url: https://github.com/octocat/Hello-World/git/commit/7638417db6d59f3c431d3e1f261cc637155684cd
author:
date: '2014-11-07T22:01:45Z'
name: Monalisa Octocat
email: octocat@github.com
committer:
date: '2014-11-07T22:01:45Z'
name: Monalisa Octocat
email: octocat@github.com
message: my commit message
tree:
url: https://api.github.com/repos/octocat/Hello-World/git/trees/691272480426f78a0138979dd3ce63b77f706feb
sha: 691272480426f78a0138979dd3ce63b77f706feb
parents:
- url: https://api.github.com/repos/octocat/Hello-World/git/commits/1acc419d4d6a9ce985db7be48c6349a0475975b5
html_url: https://github.com/octocat/Hello-World/git/commit/1acc419d4d6a9ce985db7be48c6349a0475975b5
sha: 1acc419d4d6a9ce985db7be48c6349a0475975b5
verification:
verified: false
reason: unsigned
signature: ''
payload: ''
team-discussion-comment-2:
value:
author:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
body: Do you like pineapples?
body_html: Do you like pineapples?
body_version: e6907b24d9c93cc0c5024a7af5888116
created_at: '2018-01-15T23:53:58Z'
last_edited_at: '2018-01-26T18:22:20Z'
discussion_url: https://api.github.com/teams/2403582/discussions/1
html_url: https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1
node_id: MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=
number: 1
updated_at: '2018-01-26T18:22:20Z'
url: https://api.github.com/teams/2403582/discussions/1/comments/1
reactions:
url: https://api.github.com/teams/2403582/discussions/1/reactions
total_count: 5
'+1': 3
'-1': 1
laugh: 0
confused: 0
heart: 1
hooray: 0
eyes: 1
rocket: 1
pull-request:
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
id: 1
auto_merge:
enabled_by:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
merge_method: squash
commit_title: 'feat: Add new authentication flow (#1347)'
commit_message: 'This PR adds the new OAuth2 authentication flow.
- Implements OAuth2 PKCE flow
- Adds token refresh logic
- Updates user session handling
Co-authored-by: monalisa
'
node_id: MDExOlB1bGxSZXF1ZXN0MQ==
html_url: https://github.com/octocat/Hello-World/pull/1347
diff_url: https://github.com/octocat/Hello-World/pull/1347.diff
patch_url: https://github.com/octocat/Hello-World/pull/1347.patch
issue_url: https://api.github.com/repos/octocat/Hello-World/issues/1347
commits_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
review_comments_url: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
review_comment_url: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}
comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
number: 1347
state: open
locked: true
title: Amazing new feature
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
body: Please pull these awesome changes in!
labels:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
url: https://api.github.com/repos/octocat/Hello-World/labels/bug
name: bug
description: Something isn't working
color: f29513
default: true
milestone:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id: 1002604
node_id: MDk6TWlsZXN0b25lMTAwMjYwNA==
number: 1
state: open
title: v1.0
description: Tracking milestone for version 1.0
creator:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
open_issues: 4
closed_issues: 8
created_at: '2011-04-10T20:09:31Z'
updated_at: '2014-03-03T18:58:10Z'
closed_at: '2013-02-12T13:22:01Z'
due_on: '2012-10-09T23:39:01Z'
active_lock_reason: too heated
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:01:12Z'
closed_at: '2011-01-26T19:01:12Z'
merged_at: '2011-01-26T19:01:12Z'
merge_commit_sha: e5bd3914e2e596debea16f433f57875b5b90bcd6
assignee:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
assignees:
- login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
- login: hubot
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/hubot_happy.gif
gravatar_id: ''
url: https://api.github.com/users/hubot
html_url: https://github.com/hubot
followers_url: https://api.github.com/users/hubot/followers
following_url: https://api.github.com/users/hubot/following{/other_user}
gists_url: https://api.github.com/users/hubot/gists{/gist_id}
starred_url: https://api.github.com/users/hubot/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/hubot/subscriptions
organizations_url: https://api.github.com/users/hubot/orgs
repos_url: https://api.github.com/users/hubot/repos
events_url: https://api.github.com/users/hubot/events{/privacy}
received_events_url: https://api.github.com/users/hubot/received_events
type: User
site_admin: true
requested_reviewers:
- login: other_user
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/other_user_happy.gif
gravatar_id: ''
url: https://api.github.com/users/other_user
html_url: https://github.com/other_user
followers_url: https://api.github.com/users/other_user/followers
following_url: https://api.github.com/users/other_user/following{/other_user}
gists_url: https://api.github.com/users/other_user/gists{/gist_id}
starred_url: https://api.github.com/users/other_user/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/other_user/subscriptions
organizations_url: https://api.github.com/users/other_user/orgs
repos_url: https://api.github.com/users/other_user/repos
events_url: https://api.github.com/users/other_user/events{/privacy}
received_events_url: https://api.github.com/users/other_user/received_events
type: User
site_admin: false
requested_teams:
- id: 1
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: great team.
privacy: closed
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
head:
label: octocat:new-topic
ref: new-topic
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
repo:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World.git
mirror_url: git:git.example.com/octocat/Hello-World
hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks
svn_url: https://svn.github.com/octocat/Hello-World
homepage: https://github.com
language: EN
forks_count: 9
stargazers_count: 80
watchers_count: 80
size: 108
default_branch: master
open_issues_count: 0
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
has_discussions: false
archived: false
disabled: false
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
allow_rebase_merge: true
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_merge_commit: true
allow_forking: true
forks: 123
open_issues: 123
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
watchers: 123
base:
label: octocat:master
ref: master
sha: 6dcb09b5b57875f334f61aebed695e2e4193db5e
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
repo:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World.git
mirror_url: git:git.example.com/octocat/Hello-World
hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks
svn_url: https://svn.github.com/octocat/Hello-World
homepage: https://github.com
language: EN
forks_count: 9
stargazers_count: 80
watchers_count: 80
size: 108
default_branch: master
open_issues_count: 0
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
has_discussions: false
archived: false
disabled: false
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
allow_rebase_merge: true
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_merge_commit: true
forks: 123
open_issues: 123
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
watchers: 123
_links:
self:
href: https://api.github.com/repos/octocat/Hello-World/pulls/1347
html:
href: https://github.com/octocat/Hello-World/pull/1347
issue:
href: https://api.github.com/repos/octocat/Hello-World/issues/1347
comments:
href: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
review_comments:
href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments
review_comment:
href: https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}
commits:
href: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits
statuses:
href: https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e
author_association: OWNER
draft: false
merged: false
mergeable: true
rebaseable: true
mergeable_state: clean
merged_by:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
comments: 10
review_comments: 0
maintainer_can_modify: true
commits: 3
additions: 100
deletions: 3
changed_files: 5
scim-enterprise-user:
value:
schemas:
- urn:ietf:params:scim:schemas:core:2.0:User
id: 7fce0092-d52e-4f76-b727-3955bd72c939
externalId: E012345
active: true
userName: E012345
name:
formatted: Ms. Mona Lisa Octocat
familyName: Octocat
givenName: Mona
middleName: Lisa
displayName: Mona Lisa
emails:
- value: mlisa@example.com
type: work
primary: true
roles:
- value: User
primary: false
meta:
resourceType: User
created: '2012-03-27T19:59:26.000Z'
lastModified: '2018-03-27T19:59:26.000Z'
location: https://api.github.localhost/scim/v2/Users/7fce0092-d52e-4f76-b727-3955bd72c939
pull-request-review-comment-2:
value:
url: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
pull_request_review_id: 42
id: 10
node_id: MDI0OlB1bGxSZXF1ZXN0UmV2aWV3Q29tbWVudDEw
diff_hunk: '@@ -16,33 +16,40 @@ public class Connection : IConnection...'
path: file1.txt
position: 1
original_position: 4
commit_id: 6dcb09b5b57875f334f61aebed695e2e4193db5e
original_commit_id: 9c48853fa3dc5c1c3d6f1f1cd1f2743e72652840
in_reply_to_id: 8
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
body: Great stuff!
created_at: '2011-04-14T16:00:49Z'
updated_at: '2011-04-14T16:00:49Z'
html_url: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/1
author_association: NONE
_links:
self:
href: https://api.github.com/repos/octocat/Hello-World/pulls/comments/1
html:
href: https://github.com/octocat/Hello-World/pull/1#discussion-diff-1
pull_request:
href: https://api.github.com/repos/octocat/Hello-World/pulls/1
start_line: 1
original_start_line: 1
start_side: RIGHT
line: 2
original_line: 2
side: RIGHT
organization-full:
value:
login: github
id: 1
node_id: MDEyOk9yZ2FuaXphdGlvbjE=
url: https://api.github.com/orgs/github
repos_url: https://api.github.com/orgs/github/repos
events_url: https://api.github.com/orgs/github/events
hooks_url: https://api.github.com/orgs/github/hooks
issues_url: https://api.github.com/orgs/github/issues
members_url: https://api.github.com/orgs/github/members{/member}
public_members_url: https://api.github.com/orgs/github/public_members{/member}
avatar_url: https://github.com/images/error/octocat_happy.gif
description: A great organization
name: github
company: GitHub
blog: https://github.com/blog
location: San Francisco
email: octocat@github.com
twitter_username: github
is_verified: true
has_organization_projects: true
has_repository_projects: true
public_repos: 2
public_gists: 1
followers: 20
following: 0
html_url: https://github.com/octocat
created_at: '2008-01-14T04:33:35Z'
type: Organization
total_private_repos: 100
owned_private_repos: 100
private_gists: 81
disk_usage: 10000
collaborators: 8
billing_email: mona@github.com
plan:
name: Medium
space: 400
private_repos: 20
filled_seats: 4
seats: 5
default_repository_permission: read
members_can_create_repositories: true
two_factor_requirement_enabled: true
members_allowed_repository_creation_type: all
members_can_create_public_repositories: false
members_can_create_private_repositories: false
members_can_create_internal_repositories: false
members_can_create_pages: true
members_can_create_public_pages: true
members_can_create_private_pages: true
members_can_fork_private_repositories: false
web_commit_signoff_required: false
updated_at: '2014-03-03T18:58:10Z'
dependency_graph_enabled_for_new_repositories: false
dependabot_alerts_enabled_for_new_repositories: false
dependabot_security_updates_enabled_for_new_repositories: false
advanced_security_enabled_for_new_repositories: false
secret_scanning_enabled_for_new_repositories: false
secret_scanning_push_protection_enabled_for_new_repositories: false
secret_scanning_push_protection_custom_link: https://github.com/octo-org/octo-repo/blob/main/im-blocked.md
secret_scanning_push_protection_custom_link_enabled: false
milestone:
value:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id: 1002604
node_id: MDk6TWlsZXN0b25lMTAwMjYwNA==
number: 1
state: open
title: v1.0
description: Tracking milestone for version 1.0
creator:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
open_issues: 4
closed_issues: 8
created_at: '2011-04-10T20:09:31Z'
updated_at: '2014-03-03T18:58:10Z'
closed_at: '2013-02-12T13:22:01Z'
due_on: '2012-10-09T23:39:01Z'
webhook-config:
value:
content_type: json
insecure_ssl: '0'
secret: '********'
url: https://example.com/webhook
project-column:
value:
url: https://api.github.com/projects/columns/367
project_url: https://api.github.com/projects/120
cards_url: https://api.github.com/projects/columns/367/cards
id: 367
node_id: MDEzOlByb2plY3RDb2x1bW4zNjc=
name: To Do
created_at: '2016-09-05T14:18:44Z'
updated_at: '2016-09-05T14:22:28Z'
pull-request-review-5:
value:
id: 80
node_id: MDE3OlB1bGxSZXF1ZXN0UmV2aWV3ODA=
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
body: This is close to perfect! Please address the suggested inline change. And add more about this.
state: CHANGES_REQUESTED
html_url: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
pull_request_url: https://api.github.com/repos/octocat/Hello-World/pulls/12
_links:
html:
href: https://github.com/octocat/Hello-World/pull/12#pullrequestreview-80
pull_request:
href: https://api.github.com/repos/octocat/Hello-World/pulls/12
submitted_at: '2019-11-17T17:43:43Z'
commit_id: ecdd80bb57125d7ba9641ffaa4d7d2c19d3f3091
author_association: COLLABORATOR
delete-gist-file:
value:
url: https://api.github.com/gists/2decf6c462d9b4418f2
forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks
commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits
id: 2decf6c462d9b4418f2
node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy
git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git
git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git
html_url: https://gist.github.com/2decf6c462d9b4418f2
files: null
public: true
created_at: '2022-09-20T12:11:58Z'
updated_at: '2022-09-21T10:28:06Z'
description: A gist description.
comments: 0
user: null
comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments
owner:
login: monalisa
id: 104456405
node_id: U_kgDOBhHyLQ
avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
forks: []
history:
- user:
login: monalisa
id: 104456405
node_id: U_kgyLQ
avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
version: 9cc352a89178a6d4
committed_at: '2022-09-21T10:28:06Z'
change_status:
total: 1
additions: 0
deletions: 1
url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968
truncated: false
project-card:
value:
url: https://api.github.com/projects/columns/cards/1478
id: 1478
node_id: MDExOlByb2plY3RDYXJkMTQ3OA==
note: Add payload for delete Project column
creator:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
created_at: '2016-09-05T14:21:06Z'
updated_at: '2016-09-05T14:20:22Z'
archived: false
column_url: https://api.github.com/projects/columns/367
content_url: https://api.github.com/repos/api-playground/projects-test/issues/3
project_url: https://api.github.com/projects/120
team-full:
value:
id: 1
node_id: MDQ6VGVhbTE=
url: https://api.github.com/teams/1
html_url: https://github.com/orgs/github/teams/justice-league
name: Justice League
slug: justice-league
description: A great team.
privacy: closed
permission: admin
members_url: https://api.github.com/teams/1/members{/member}
repositories_url: https://api.github.com/teams/1/repos
members_count: 3
repos_count: 10
created_at: '2017-07-14T16:53:42Z'
updated_at: '2017-08-17T12:37:15Z'
organization:
login: github
id: 1
node_id: MDEyOk9yZ2FuaXphdGlvbjE=
url: https://api.github.com/orgs/github
repos_url: https://api.github.com/orgs/github/repos
events_url: https://api.github.com/orgs/github/events
hooks_url: https://api.github.com/orgs/github/hooks
issues_url: https://api.github.com/orgs/github/issues
members_url: https://api.github.com/orgs/github/members{/member}
public_members_url: https://api.github.com/orgs/github/public_members{/member}
avatar_url: https://github.com/images/error/octocat_happy.gif
description: A great organization
name: github
company: GitHub
blog: https://github.com/blog
location: San Francisco
email: octocat@github.com
has_organization_projects: true
has_repository_projects: true
public_repos: 2
public_gists: 1
followers: 20
following: 0
html_url: https://github.com/octocat
created_at: '2008-01-14T04:33:35Z'
updated_at: '2017-08-17T12:37:15Z'
type: Organization
ldap_dn: uid=asdf,ou=users,dc=github,dc=com
issue:
value:
id: 1
node_id: MDU6SXNzdWUx
url: https://api.github.com/repos/octocat/Hello-World/issues/1347
repository_url: https://api.github.com/repos/octocat/Hello-World
labels_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}
comments_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/comments
events_url: https://api.github.com/repos/octocat/Hello-World/issues/1347/events
html_url: https://github.com/octocat/Hello-World/issues/1347
number: 1347
state: open
title: Found a bug
body: I'm having a problem with this.
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
labels:
- id: 208045946
node_id: MDU6TGFiZWwyMDgwNDU5NDY=
url: https://api.github.com/repos/octocat/Hello-World/labels/bug
name: bug
description: Something isn't working
color: f29513
default: true
assignee:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
assignees:
- login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
milestone:
url: https://api.github.com/repos/octocat/Hello-World/milestones/1
html_url: https://github.com/octocat/Hello-World/milestones/v1.0
labels_url: https://api.github.com/repos/octocat/Hello-World/milestones/1/labels
id: 1002604
node_id: MDk6TWlsZXN0b25lMTAwMjYwNA==
number: 1
state: open
title: v1.0
description: Tracking milestone for version 1.0
creator:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
open_issues: 4
closed_issues: 8
created_at: '2011-04-10T20:09:31Z'
updated_at: '2014-03-03T18:58:10Z'
closed_at: '2013-02-12T13:22:01Z'
due_on: '2012-10-09T23:39:01Z'
locked: true
active_lock_reason: too heated
comments: 0
pull_request:
url: https://api.github.com/repos/octocat/Hello-World/pulls/1347
html_url: https://github.com/octocat/Hello-World/pull/1347
diff_url: https://github.com/octocat/Hello-World/pull/1347.diff
patch_url: https://github.com/octocat/Hello-World/pull/1347.patch
closed_at: null
created_at: '2011-04-22T13:33:48Z'
updated_at: '2011-04-22T13:33:48Z'
closed_by:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
author_association: COLLABORATOR
state_reason: completed
rename-gist-file:
value:
url: https://api.github.com/gists/2decf6c462d9b4418f2
forks_url: https://api.github.com/gists/2decf6c462d9b4418f2/forks
commits_url: https://api.github.com/gists/2decf6c462d9b4418f2/commits
id: 2decf6c462d9b4418f2
node_id: G_kwDOBhHyLdoAIDg0ODFZDliNDQxOGYy
git_pull_url: https://gist.github.com/2decf6c462d9b4418f2.git
git_push_url: https://gist.github.com/2decf6c462d9b4418f2.git
html_url: https://gist.github.com/2decf6c462d9b4418f2
files:
goodbye.py:
filename: goodbye.py
type: application/x-python
language: Python
raw_url: https://gist.githubusercontent.com/monalisa/8481a81af6b7a2decf6c462d9b4418f2/raw/ac3e6daf176fafe73609fd000cd188e4472010fb/goodbye.py
size: 4
truncated: false
content: '# Hello world'
public: true
created_at: '2022-09-20T12:11:58Z'
updated_at: '2022-09-21T10:28:06Z'
description: A gist description.
comments: 0
user: null
comments_url: https://api.github.com/gists/2decf6c462d9b4418f2/comments
owner:
login: monalisa
id: 104456405
node_id: U_kgDOBhHyLQ
avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
forks: []
history:
- user:
login: monalisa
id: 104456405
node_id: U_kgyLQ
avatar_url: https://avatars.githubusercontent.com/u/104456405?v=4
gravatar_id: ''
url: https://api.github.com/users/monalisa
html_url: https://github.com/monalisa
followers_url: https://api.github.com/users/monalisa/followers
following_url: https://api.github.com/users/monalisa/following{/other_user}
gists_url: https://api.github.com/users/monalisa/gists{/gist_id}
starred_url: https://api.github.com/users/monalisa/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/monalisa/subscriptions
organizations_url: https://api.github.com/users/monalisa/orgs
repos_url: https://api.github.com/users/monalisa/repos
events_url: https://api.github.com/users/monalisa/events{/privacy}
received_events_url: https://api.github.com/users/monalisa/received_events
type: User
site_admin: true
version: 468aac8caed5f0c3b859b8286968
committed_at: '2022-09-21T10:28:06Z'
change_status:
total: 0
additions: 0
deletions: 0
url: https://api.github.com/gists/8481a81af6b7a2d418f2/468aac8caed5f0c3b859b8286968
truncated: false
full-repository:
value:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World.git
mirror_url: git:git.example.com/octocat/Hello-World
hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks
svn_url: https://svn.github.com/octocat/Hello-World
homepage: https://github.com
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
html_url: https://github.com/licenses/mit
language: EN
forks_count: 9
forks: 9
stargazers_count: 80
watchers_count: 80
watchers: 80
size: 108
default_branch: master
open_issues_count: 0
open_issues: 0
is_template: false
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
has_discussions: true
archived: false
disabled: false
visibility: public
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
pull: true
push: false
admin: false
allow_rebase_merge: true
template_repository:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World-Template
full_name: octocat/Hello-World-Template
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World-Template
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World-Template
archive_url: https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World-Template/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World-Template/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World-Template/downloads
events_url: https://api.github.com/repos/octocat/Hello-World-Template/events
forks_url: https://api.github.com/repos/octocat/Hello-World-Template/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World-Template.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World-Template/languages
merges_url: https://api.github.com/repos/octocat/Hello-World-Template/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}
ssh_url: git@github.com:octocat/Hello-World-Template.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World-Template/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World-Template/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World-Template/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World-Template/tags
teams_url: https://api.github.com/repos/octocat/Hello-World-Template/teams
trees_url: https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World-Template.git
mirror_url: git:git.example.com/octocat/Hello-World-Template
hooks_url: https://api.github.com/repos/octocat/Hello-World-Template/hooks
svn_url: https://svn.github.com/octocat/Hello-World-Template
homepage: https://github.com
language: EN
forks: 9
forks_count: 9
stargazers_count: 80
watchers_count: 80
watchers: 80
size: 108
default_branch: master
open_issues: 0
open_issues_count: 0
is_template: true
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
html_url: https://api.github.com/licenses/mit
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
archived: false
disabled: false
visibility: public
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
allow_rebase_merge: true
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_auto_merge: false
delete_branch_on_merge: true
allow_merge_commit: true
subscribers_count: 42
network_count: 0
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_auto_merge: false
delete_branch_on_merge: true
allow_merge_commit: true
allow_forking: true
web_commit_signoff_required: false
subscribers_count: 42
network_count: 0
organization:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: Organization
site_admin: false
parent:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World.git
mirror_url: git:git.example.com/octocat/Hello-World
hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks
svn_url: https://svn.github.com/octocat/Hello-World
homepage: https://github.com
language: EN
forks_count: 9
stargazers_count: 80
watchers_count: 80
size: 108
default_branch: master
open_issues_count: 0
is_template: true
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
archived: false
disabled: false
visibility: public
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
allow_rebase_merge: true
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_auto_merge: false
delete_branch_on_merge: true
allow_merge_commit: true
subscribers_count: 42
network_count: 0
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
html_url: https://api.github.com/licenses/mit
forks: 1
open_issues: 1
watchers: 1
source:
id: 1296269
node_id: MDEwOlJlcG9zaXRvcnkxMjk2MjY5
name: Hello-World
full_name: octocat/Hello-World
owner:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
private: false
html_url: https://github.com/octocat/Hello-World
description: This your first repo!
fork: false
url: https://api.github.com/repos/octocat/Hello-World
archive_url: https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}
assignees_url: https://api.github.com/repos/octocat/Hello-World/assignees{/user}
blobs_url: https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}
branches_url: https://api.github.com/repos/octocat/Hello-World/branches{/branch}
collaborators_url: https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}
comments_url: https://api.github.com/repos/octocat/Hello-World/comments{/number}
commits_url: https://api.github.com/repos/octocat/Hello-World/commits{/sha}
compare_url: https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}
contents_url: https://api.github.com/repos/octocat/Hello-World/contents/{+path}
contributors_url: https://api.github.com/repos/octocat/Hello-World/contributors
deployments_url: https://api.github.com/repos/octocat/Hello-World/deployments
downloads_url: https://api.github.com/repos/octocat/Hello-World/downloads
events_url: https://api.github.com/repos/octocat/Hello-World/events
forks_url: https://api.github.com/repos/octocat/Hello-World/forks
git_commits_url: https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}
git_refs_url: https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}
git_tags_url: https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}
git_url: git:github.com/octocat/Hello-World.git
issue_comment_url: https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}
issue_events_url: https://api.github.com/repos/octocat/Hello-World/issues/events{/number}
issues_url: https://api.github.com/repos/octocat/Hello-World/issues{/number}
keys_url: https://api.github.com/repos/octocat/Hello-World/keys{/key_id}
labels_url: https://api.github.com/repos/octocat/Hello-World/labels{/name}
languages_url: https://api.github.com/repos/octocat/Hello-World/languages
merges_url: https://api.github.com/repos/octocat/Hello-World/merges
milestones_url: https://api.github.com/repos/octocat/Hello-World/milestones{/number}
notifications_url: https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}
pulls_url: https://api.github.com/repos/octocat/Hello-World/pulls{/number}
releases_url: https://api.github.com/repos/octocat/Hello-World/releases{/id}
ssh_url: git@github.com:octocat/Hello-World.git
stargazers_url: https://api.github.com/repos/octocat/Hello-World/stargazers
statuses_url: https://api.github.com/repos/octocat/Hello-World/statuses/{sha}
subscribers_url: https://api.github.com/repos/octocat/Hello-World/subscribers
subscription_url: https://api.github.com/repos/octocat/Hello-World/subscription
tags_url: https://api.github.com/repos/octocat/Hello-World/tags
teams_url: https://api.github.com/repos/octocat/Hello-World/teams
trees_url: https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}
clone_url: https://github.com/octocat/Hello-World.git
mirror_url: git:git.example.com/octocat/Hello-World
hooks_url: https://api.github.com/repos/octocat/Hello-World/hooks
svn_url: https://svn.github.com/octocat/Hello-World
homepage: https://github.com
language: EN
forks_count: 9
stargazers_count: 80
watchers_count: 80
size: 108
default_branch: master
open_issues_count: 0
is_template: true
topics:
- octocat
- atom
- electron
- api
has_issues: true
has_projects: true
has_wiki: true
has_pages: false
has_downloads: true
archived: false
disabled: false
visibility: public
pushed_at: '2011-01-26T19:06:43Z'
created_at: '2011-01-26T19:01:12Z'
updated_at: '2011-01-26T19:14:43Z'
permissions:
admin: false
push: false
pull: true
allow_rebase_merge: true
temp_clone_token: ABTLWHOULUVAXGTRYU7OC2876QJ2O
allow_squash_merge: true
allow_auto_merge: false
delete_branch_on_merge: true
allow_merge_commit: true
subscribers_count: 42
network_count: 0
license:
key: mit
name: MIT License
url: https://api.github.com/licenses/mit
spdx_id: MIT
node_id: MDc6TGljZW5zZW1pdA==
html_url: https://api.github.com/licenses/mit
forks: 1
open_issues: 1
watchers: 1
check-run:
value:
id: 4
head_sha: ce587453ced02b1526dfb4cb910479d431683101
node_id: MDg6Q2hlY2tSdW40
external_id: ''
url: https://api.github.com/repos/github/hello-world/check-runs/4
html_url: https://github.com/github/hello-world/runs/4
details_url: https://example.com
status: completed
conclusion: neutral
started_at: '2018-05-04T01:14:52Z'
completed_at: '2018-05-04T01:14:52Z'
output:
title: Mighty Readme report
summary: There are 0 failures, 2 warnings, and 1 notice.
text: You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.
annotations_count: 2
annotations_url: https://api.github.com/repos/github/hello-world/check-runs/4/annotations
name: mighty_readme
check_suite:
id: 5
app:
id: 1
slug: octoapp
node_id: MDExOkludGVncmF0aW9uMQ==
owner:
login: github
id: 1
node_id: MDEyOk9yZ2FuaXphdGlvbjE=
url: https://api.github.com/orgs/github
repos_url: https://api.github.com/orgs/github/repos
events_url: https://api.github.com/orgs/github/events
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: true
name: Octocat App
description: ''
external_url: https://example.com
html_url: https://github.com/apps/octoapp
created_at: '2017-07-08T16:18:44-04:00'
updated_at: '2017-07-08T16:18:44-04:00'
permissions:
metadata: read
contents: read
issues: write
single_file: write
events:
- push
- pull_request
pull_requests:
- url: https://api.github.com/repos/github/hello-world/pulls/1
id: 1934
number: 3956
head:
ref: say-hello
sha: 3dca65fa3e8d4b3da3f3d056c59aee1c50f41390
repo:
id: 526
url: https://api.github.com/repos/github/hello-world
name: hello-world
base:
ref: master
sha: e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f
repo:
id: 526
url: https://api.github.com/repos/github/hello-world
name: hello-world
org-membership-2:
value:
url: https://api.github.com/orgs/octocat/memberships/defunkt
state: active
role: admin
organization_url: https://api.github.com/orgs/octocat
organization:
login: github
id: 1
node_id: MDEyOk9yZ2FuaXphdGlvbjE=
url: https://api.github.com/orgs/github
repos_url: https://api.github.com/orgs/github/repos
events_url: https://api.github.com/orgs/github/events
hooks_url: https://api.github.com/orgs/github/hooks
issues_url: https://api.github.com/orgs/github/issues
members_url: https://api.github.com/orgs/github/members{/member}
public_members_url: https://api.github.com/orgs/github/public_members{/member}
avatar_url: https://github.com/images/error/octocat_happy.gif
description: A great organization
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
org-hook-2:
value:
id: 1
url: https://api.github.com/orgs/octocat/hooks/1
ping_url: https://api.github.com/orgs/octocat/hooks/1/pings
deliveries_url: https://api.github.com/repos/octocat/Hello-World/hooks/12345678/deliveries
name: web
events:
- pull_request
active: true
config:
url: http://example.com
content_type: json
updated_at: '2011-09-06T20:39:23Z'
created_at: '2011-09-06T17:26:27Z'
type: Organization
team-membership-response-if-users-membership-with-team-is-now-pending:
summary: Response if user's membership with team is now pending
value:
url: https://api.github.com/teams/1/memberships/octocat
role: member
state: pending
private-user:
value:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
name: monalisa octocat
company: GitHub
blog: https://github.com/blog
location: San Francisco
email: octocat@github.com
hireable: false
bio: There once was...
public_repos: 2
public_gists: 1
followers: 20
following: 0
created_at: '2008-01-14T04:33:35Z'
updated_at: '2008-01-14T04:33:35Z'
private_gists: 81
total_private_repos: 100
owned_private_repos: 100
disk_usage: 10000
collaborators: 8
two_factor_authentication: true
plan:
name: Medium
space: 400
private_repos: 20
collaborators: 0
status-check-policy:
value:
checks: []
url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks
strict: true
contexts:
- continuous-integration/travis-ci
contexts_url: https://api.github.com/repos/octocat/Hello-World/branches/master/protection/required_status_checks/contexts
release:
value:
url: https://api.github.com/repos/octocat/Hello-World/releases/1
html_url: https://github.com/octocat/Hello-World/releases/v1.0.0
assets_url: https://api.github.com/repos/octocat/Hello-World/releases/1/assets
upload_url: https://uploads.github.com/repos/octocat/Hello-World/releases/1/assets{?name,label}
tarball_url: https://api.github.com/repos/octocat/Hello-World/tarball/v1.0.0
zipball_url: https://api.github.com/repos/octocat/Hello-World/zipball/v1.0.0
discussion_url: https://github.com/octocat/Hello-World/discussions/90
id: 1
node_id: MDc6UmVsZWFzZTE=
tag_name: v1.0.0
target_commitish: master
name: v1.0.0
body: Description of the release
draft: false
prerelease: false
created_at: '2013-02-27T19:35:32Z'
published_at: '2013-02-27T19:35:32Z'
author:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
assets:
- url: https://api.github.com/repos/octocat/Hello-World/releases/assets/1
browser_download_url: https://github.com/octocat/Hello-World/releases/download/v1.0.0/example.zip
id: 1
node_id: MDEyOlJlbGVhc2VBc3NldDE=
name: example.zip
label: short description
state: uploaded
content_type: application/zip
size: 1024
download_count: 42
created_at: '2013-02-27T19:35:32Z'
updated_at: '2013-02-27T19:35:32Z'
uploader:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
gist-comment:
value:
id: 1
node_id: MDExOkdpc3RDb21tZW50MQ==
url: https://api.github.com/gists/a6db0bec360bb87e9418/comments/1
body: Just commenting for the sake of commenting
user:
login: octocat
id: 1
node_id: MDQ6VXNlcjE=
avatar_url: https://github.com/images/error/octocat_happy.gif
gravatar_id: ''
url: https://api.github.com/users/octocat
html_url: https://github.com/octocat
followers_url: https://api.github.com/users/octocat/followers
following_url: https://api.github.com/users/octocat/following{/other_user}
gists_url: https://api.github.com/users/octocat/gists{/gist_id}
starred_url: https://api.github.com/users/octocat/starred{/owner}{/repo}
subscriptions_url: https://api.github.com/users/octocat/subscriptions
organizations_url: https://api.github.com/users/octocat/orgs
repos_url: https://api.github.com/users/octocat/repos
events_url: https://api.github.com/users/octocat/events{/privacy}
received_events_url: https://api.github.com/users/octocat/received_events
type: User
site_admin: false
created_at: '2011-04-18T23:23:56Z'
updated_at: '2011-04-18T23:23:56Z'
author_association: COLLABORATOR
parameters:
invitation-id:
name: invitation_id
description: The unique identifier of the invitation.
in: path
required: true
schema:
type: integer
scim-user-id:
name: scim_user_id
description: The unique identifier of the SCIM user.
in: path
required: true
schema:
type: string
username:
name: username
description: The handle for the GitHub user account.
in: path
required: true
schema:
type: string
runner-group-id:
name: runner_group_id
description: Unique identifier of the self-hosted runner group.
in: path
required: true
schema:
type: integer
check-run-id:
name: check_run_id
description: The unique identifier of the check run.
in: path
required: true
schema:
type: integer
branch:
name: branch
description: The name of the branch. Cannot contain wildcard characters. To use wildcard characters in branch names, use [the GraphQL API](https://docs.github.com/enterprise-server@3.9/graphql).
in: path
required: true
schema:
type: string
x-multi-segment: true
hook-id:
name: hook_id
description: The unique identifier of the hook. You can find this value in the `X-GitHub-Hook-ID` header of a webhook delivery.
in: path
required: true
schema:
type: integer
repo:
name: repo
description: The name of the repository without the `.git` extension. The name is not case sensitive.
in: path
required: true
schema:
type: string
authorization-id:
name: authorization_id
description: The unique identifier of the authorization.
in: path
required: true
schema:
type: integer
secret-name:
name: secret_name
description: The name of the secret.
in: path
required: true
schema:
type: string
scim-group-id:
name: scim_group_id
description: A unique identifier of the SCIM group.
in: path
required: true
schema:
type: string
example: 7fce0092-d52e-4f76-b727-3955bd72c939
variable-name:
name: name
description: The name of the variable.
in: path
required: true
schema:
type: string
pull-number:
name: pull_number
description: The number that identifies the pull request.
in: path
required: true
schema:
type: integer
release-id:
name: release_id
description: The unique identifier of the release.
in: path
required: true
schema:
type: integer
issue-number:
name: issue_number
description: The number that identifies the issue.
in: path
required: true
schema:
type: integer
team-id:
name: team_id
description: The unique identifier of the team.
in: path
required: true
schema:
type: integer
project-id:
name: project_id
description: The unique identifier of the project.
in: path
required: true
schema:
type: integer
branch-policy-id:
name: branch_policy_id
in: path
required: true
description: The unique identifier of the branch policy.
schema:
type: integer
discussion-number:
name: discussion_number
description: The number that identifies the discussion.
in: path
required: true
schema:
type: integer
column-id:
name: column_id
description: The unique identifier of the column.
in: path
required: true
schema:
type: integer
pre-receive-hook-id:
name: pre_receive_hook_id
description: The unique identifier of the pre-receive hook.
in: path
required: true
schema:
type: integer
org:
name: org
description: The organization name. The name is not case sensitive.
in: path
required: true
schema:
type: string
git-ref-only:
name: ref
description: The Git reference. For more information, see "[Git References](https://git-scm.com/book/en/v2/Git-Internals-Git-References)" in the Git documentation.
in: path
required: true
example: heads/feature-a
schema:
type: string
x-multi-segment: true
comment-number:
name: comment_number
description: The number that identifies the comment.
in: path
required: true
schema:
type: integer
gist-id:
name: gist_id
description: The unique identifier of the gist.
in: path
required: true
schema:
type: string
milestone-number:
name: milestone_number
description: The number that identifies the milestone.
in: path
required: true
schema:
type: integer
dependabot-alert-number:
name: alert_number
in: path
description: 'The number that identifies a Dependabot alert in its repository.
You can find this at the end of the URL for a Dependabot alert within GitHub,
or in `number` fields in the response from the
`GET /repos/{owner}/{repo}/dependabot/alerts` operation.'
required: true
schema:
$ref: '#/components/schemas/alert-number'
owner:
name: owner
description: The account owner of the repository. The name is not case sensitive.
in: path
required: true
schema:
type: string
comment-id:
name: comment_id
description: The unique identifier of the comment.
in: path
required: true
schema:
type: integer
role-id:
name: role_id
description: The unique identifier of the role.
in: path
required: true
schema:
type: integer
alert-number:
name: alert_number
in: path
description: The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.
required: true
schema:
$ref: '#/components/schemas/alert-number'
environment-name:
name: environment_name
in: path
required: true
description: The name of the environment. The name must be URL encoded. For example, any slashes in the name must be replaced with `%2F`.
schema:
type: string
review-id:
name: review_id
description: The unique identifier of the review.
in: path
required: true
schema:
type: integer
asset-id:
name: asset_id
description: The unique identifier of the asset.
in: path
required: true
schema:
type: integer
card-id:
name: card_id
description: The unique identifier of the card.
in: path
required: true
schema:
type: integer
team-slug:
name: team_slug
description: The slug of the team name.
in: path
required: true
schema:
type: string
responses:
forbidden:
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
scim_bad_request:
description: Bad request
content:
application/json:
schema:
$ref: '#/components/schemas/scim-error_2'
application/scim+json:
schema:
$ref: '#/components/schemas/scim-error_2'
service_unavailable:
description: Service unavailable
content:
application/json:
schema:
type: object
properties:
code:
type: string
message:
type: string
documentation_url:
type: string
bad_request:
description: Bad Request
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
application/scim+json:
schema:
$ref: '#/components/schemas/scim-error'
gone:
description: Gone
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
moved_permanently:
description: Moved permanently
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
permission_denied:
description: Permission denied
duplicate_record_detected:
description: Duplicate record detected
code_scanning_forbidden_write:
description: Response if the repository is archived or if GitHub Advanced Security is not enabled for this repository
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
scim_internal_error:
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/scim-error_2'
application/scim+json:
schema:
$ref: '#/components/schemas/scim-error_2'
validation_failed_simple:
description: Validation failed, or the endpoint has been spammed.
content:
application/json:
schema:
$ref: '#/components/schemas/validation-error-simple'
temporary_redirect:
description: Temporary Redirect
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
authorization_failure:
description: Authorization failure
conflict:
description: Conflict
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
requires_authentication:
description: Requires authentication
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
code_scanning_conflict:
description: Response if there is already a validation run in progress with a different default setup configuration
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
not_found:
description: Resource not found
content:
application/json:
schema:
$ref: '#/components/schemas/basic-error'
scim_too_many_requests:
description: Too many requests
content:
application/json:
schema:
$ref: '#/components/schemas/scim-error_2'
application/scim+json:
schema:
$ref: '#/components/schemas/scim-error_2'
not_modified:
description: Not modified
validation_failed:
description: Validation failed, or the endpoint has been spammed.
content:
application/json:
schema:
$ref: '#/components/schemas/validation-error'
securitySchemes:
bearerHttpAuthentication:
description: Bearer Token
type: http
scheme: Bearer
externalDocs:
description: GitHub Enterprise Developer Docs
url: https://docs.github.com/enterprise-server@3.9/rest/
x-webhooks:
branch-protection-rule-created:
post:
summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.'
description: A branch protection rule was created.
operationId: branch-protection-rule/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-branch-protection-rule-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
- app
branch-protection-rule-deleted:
post:
summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.'
description: A branch protection rule was deleted.
operationId: branch-protection-rule/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-branch-protection-rule-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
- app
branch-protection-rule-edited:
post:
summary: 'This event occurs when there is activity relating to branch protection rules. For more information, see "[About protected branches](https://docs.github.com/enterprise-server@3.9/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches)." For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#branchprotectionrule) or "[Branch protection](https://docs.github.com/enterprise-server@3.9/rest/branches/branch-protection)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.'
description: A branch protection rule was edited.
operationId: branch-protection-rule/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#branch_protection_rule
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-branch-protection-rule-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: branch_protection_rule
supported-webhook-types:
- repository
- organization
- app
cache-sync:
post:
summary: This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see "[About repository caching](https://docs.github.com/enterprise-server@3.9/admin/enterprise-management/caching-repositories/about-repository-caching)."
operationId: cache-sync
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#cache_sync
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-cache-sync'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: cache_sync
supported-webhook-types:
- repository
- organization
- app
check-run-completed:
post:
summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: A check run was completed, and a conclusion is available.
operationId: check-run/completed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-completed'
examples:
default:
$ref: '#/components/examples/check-run-completed'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-completed-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-completed-form-encoded'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-run-created:
post:
summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: A new check run was created.
operationId: check-run/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-created'
examples:
default:
$ref: '#/components/examples/check-run-created'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-created-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-created-form-encoded'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-run-requested-action:
post:
summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: A check run completed, and someone requested a followup action that your app provides. Only the GitHub App someone requests to perform an action will receive the `requested_action` payload. For more information, see "[Creating CI tests with the Checks API](https://docs.github.com/enterprise-server@3.9/developers/apps/guides/creating-ci-tests-with-the-checks-api)."
operationId: check-run/requested-action
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-requested-action'
examples:
default:
$ref: '#/components/examples/check-run-requested-action'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-requested-action-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-requested-action-form-encoded'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-run-rerequested:
post:
summary: 'This event occurs when there is activity relating to a check run. For information about check runs, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checkrun) or "[Check Runs](https://docs.github.com/enterprise-server@3.9/rest/checks/runs)" in the REST API documentation.
For activity relating to check suites, use the `check-suite` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" repository permission. To receive the `rerequested` and `requested_action` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check run was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: Someone requested to re-run a check run. Only the GitHub App that someone requests to re-run the check will receive the `rerequested` payload.
operationId: check-run/rerequested
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-run-rerequested'
examples:
default:
$ref: '#/components/examples/check-run-rerequested'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-check-run-rerequested-form-encoded'
examples:
default:
$ref: '#/components/examples/check-run-rerequested-form-encoded'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: check_run
supported-webhook-types:
- repository
- organization
- app
check-suite-completed:
post:
summary: 'This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)" in the REST API documentation.
For activity relating to check runs, use the `check_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: All check runs in a check suite have completed, and a conclusion is available.
operationId: check-suite/completed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-suite-completed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: check_suite
supported-webhook-types:
- repository
- organization
- app
check-suite-requested:
post:
summary: 'This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)" in the REST API documentation.
For activity relating to check runs, use the `check_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: Someone requested to run a check suite. By default, check suites are automatically created when you create a check run. For more information, see [the GraphQL API documentation for creating a check run](https://docs.github.com/enterprise-server@3.9/graphql/reference/mutations#createcheckrun) or "[Create a check run](https://docs.github.com/enterprise-server@3.9/rest/checks/runs#create-a-check-run)" in the REST API documentation.
operationId: check-suite/requested
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-suite-requested'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: check_suite
supported-webhook-types:
- repository
- organization
- app
check-suite-rerequested:
post:
summary: 'This event occurs when there is activity relating to a check suite. For information about check suites, see "[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.9/rest/guides/getting-started-with-the-checks-api)." For information about the APIs to manage check suites, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#checksuite) or "[Check Suites](https://docs.github.com/enterprise-server@3.9/rest/checks/suites)" in the REST API documentation.
For activity relating to check runs, use the `check_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Checks" permission. To receive the `requested` and `rerequested` event types, the app must have at least write-level access for the "Checks" permission. GitHub Apps with write-level access for the "Checks" permission are automatically subscribed to this webhook event.
Repository and organization webhooks only receive payloads for the `completed` event types in repositories.
**Note**: The API only looks for pushes in the repository where the check suite was created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.'
description: Someone requested to re-run the check runs in a check suite. For more information, see [the GraphQL API documentation for creating a check suite](https://docs.github.com/enterprise-server@3.9/graphql/reference/mutations#createchecksuite) or "[Create a check suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#create-a-check-suite)" in the REST API documentation.
operationId: check-suite/rerequested
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#check_suite
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-check-suite-rerequested'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: check_suite
supported-webhook-types:
- repository
- organization
- app
code-scanning-alert-appeared-in-branch:
post:
summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.'
description: A previously created code scanning alert appeared in another branch. This can happen when a branch is merged into or created from a branch with a pre-existing code scanning alert.
operationId: code-scanning-alert/appeared-in-branch
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-code-scanning-alert-appeared-in-branch'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
- app
code-scanning-alert-closed-by-user:
post:
summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.'
description: Someone closed a code scanning alert.
operationId: code-scanning-alert/closed-by-user
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-code-scanning-alert-closed-by-user'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
- app
code-scanning-alert-created:
post:
summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.'
description: A code scanning alert was created in a repository.
operationId: code-scanning-alert/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-code-scanning-alert-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
- app
code-scanning-alert-fixed:
post:
summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.'
description: A code scanning alert was fixed in a branch by a commit.
operationId: code-scanning-alert/fixed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-code-scanning-alert-fixed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
- app
code-scanning-alert-reopened:
post:
summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.'
description: A previously fixed code scanning alert reappeared in a branch.
operationId: code-scanning-alert/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-code-scanning-alert-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
- app
code-scanning-alert-reopened-by-user:
post:
summary: 'This event occurs when there is activity relating to code scanning alerts in a repository. For more information, see "[About code scanning](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning)" and "[About code scanning alerts](https://docs.github.com/enterprise-server@3.9/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/about-code-scanning-alerts)." For information about the API to manage code scanning, see "[Code scanning](https://docs.github.com/enterprise-server@3.9/rest/code-scanning)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Code scanning alerts" repository permission.'
description: Someone reopened a code scanning alert.
operationId: code-scanning-alert/reopened-by-user
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#code_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-code-scanning-alert-reopened-by-user'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: code_scanning_alert
supported-webhook-types:
- repository
- organization
- app
commit-comment-created:
post:
summary: 'This event occurs when there is activity relating to commit comments. For more information about commit comments, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request)." For information about the APIs to manage commit comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#commitcomment) or "[Commit comments](https://docs.github.com/enterprise-server@3.9/rest/commits/comments)" in the REST API documentation.
For activity relating to comments on pull request reviews, use the `pull_request_review_comment` event. For activity relating to issue comments, use the `issue_comment` event. For activity relating to discussion comments, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: Someone commented on a commit.
operationId: commit-comment/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#commit_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-commit-comment-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: commit_comment
supported-webhook-types:
- repository
- organization
- app
create:
post:
summary: 'This event occurs when a Git branch or tag is created.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Notes**:
- This event will not occur when more than three tags are created at once.
- Payloads are capped at 25 MB. If an event generates a larger payload, GitHub will not deliver a payload for that webhook event. This may happen, for example, if many branches or tags are pushed at once. We suggest monitoring your payload size to ensure delivery.'
operationId: create
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#create
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-create'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: create
supported-webhook-types:
- repository
- organization
- app
delete:
post:
summary: 'This event occurs when a Git branch or tag is deleted. To subscribe to all pushes to a repository, including
branch and tag deletions, use the [`push`](#push) webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Note**: This event will not occur when more than three tags are deleted at once.'
operationId: delete
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#delete
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-delete'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: delete
supported-webhook-types:
- repository
- organization
- app
dependabot-alert-created:
post:
summary: 'This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.'
description: A manifest file change introduced a vulnerable dependency, or a GitHub Security Advisory was published and an existing dependency was found to be vulnerable.
operationId: dependabot-alert/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-dependabot-alert-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
- app
dependabot-alert-dismissed:
post:
summary: 'This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.'
description: A Dependabot alert was manually closed.
operationId: dependabot-alert/dismissed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-dependabot-alert-dismissed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
- app
dependabot-alert-fixed:
post:
summary: 'This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.'
description: A manifest file change removed a vulnerability.
operationId: dependabot-alert/fixed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-dependabot-alert-fixed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
- app
dependabot-alert-reintroduced:
post:
summary: 'This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.'
description: A manifest file change introduced a vulnerable dependency that had previously been fixed.
operationId: dependabot-alert/reintroduced
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-dependabot-alert-reintroduced'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
- app
dependabot-alert-reopened:
post:
summary: 'This event occurs when there is activity relating to Dependabot alerts.
For more information about Dependabot alerts, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)." For information about the API to manage Dependabot alerts, see "[Dependabot alerts](https://docs.github.com/enterprise-server@3.9/rest/dependabot/alerts)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Dependabot alerts" repository permission.
**Note**: Webhook events for Dependabot alerts are currently in beta and subject to change.'
description: A Dependabot alert was manually reopened.
operationId: dependabot-alert/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#dependabot_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-dependabot-alert-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: dependabot_alert
supported-webhook-types:
- repository
- organization
- app
deploy-key-created:
post:
summary: 'This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-server@3.9/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A deploy key was created.
operationId: deploy-key/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deploy_key
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deploy-key-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deploy_key
supported-webhook-types:
- repository
- organization
- app
deploy-key-deleted:
post:
summary: 'This event occurs when there is activity relating to deploy keys. For more information, see "[Managing deploy keys](https://docs.github.com/enterprise-server@3.9/developers/overview/managing-deploy-keys)." For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deploykey) or "[Deploy keys](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A deploy key was deleted.
operationId: deploy-key/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deploy_key
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deploy-key-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deploy_key
supported-webhook-types:
- repository
- organization
- app
deployment-created:
post:
summary: 'This event occurs when there is activity relating to deployments. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation.
For activity relating to deployment status, use the `deployment_status` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A deployment was created.
operationId: deployment/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deployment-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deployment
supported-webhook-types:
- repository
- organization
- app
deployment-review-approved:
post:
summary: 'This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation.
For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A deployment review was approved.
operationId: deployment-review/approved
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deployment-review-approved'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deployment_review
supported-webhook-types:
- app
deployment-review-rejected:
post:
summary: 'This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation.
For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A deployment review was rejected.
operationId: deployment-review/rejected
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deployment-review-rejected'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deployment_review
supported-webhook-types:
- app
deployment-review-requested:
post:
summary: 'This event occurs when there is activity relating to deployment reviews. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation.
For activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A deployment review was requested.
operationId: deployment-review/requested
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_review
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deployment-review-requested'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deployment_review
supported-webhook-types:
- app
deployment-status-created:
post:
summary: 'This event occurs when there is activity relating to deployment statuses. For more information, see "[About deployments](https://docs.github.com/enterprise-server@3.9/actions/deployment/about-deployments)." For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#deployment) or "[Deployments](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments)" in the REST API documentation.
For activity relating to deployment creation, use the `deployment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Deployments" repository permission.'
description: A new deployment status was created.
operationId: deployment-status/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#deployment_status
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-deployment-status-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: deployment_status
supported-webhook-types:
- repository
- organization
- app
discussion-answered:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A comment on the discussion was marked as the answer.
operationId: discussion/answered
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-answered'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-category-changed:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: The category of a discussion was changed.
operationId: discussion/category-changed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-category-changed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-closed:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was closed.
operationId: discussion/closed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: discussions
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.9.0
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-closed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-comment-created:
post:
summary: 'This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A comment on a discussion was created.
operationId: discussion-comment/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-comment-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
- app
discussion-comment-deleted:
post:
summary: 'This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A comment on a discussion was deleted.
operationId: discussion-comment/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-comment-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
- app
discussion-comment-edited:
post:
summary: 'This event occurs when there is activity relating to a comment on a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A comment on a discussion was edited.
operationId: discussion-comment/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-comment-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion_comment
supported-webhook-types:
- repository
- organization
- app
discussion-created:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was created.
operationId: discussion/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-deleted:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was deleted.
operationId: discussion/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-edited:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: The title or body on a discussion was edited, or the category of the discussion was changed.
operationId: discussion/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-labeled:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A label was added to a discussion.
operationId: discussion/labeled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-labeled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-locked:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was locked.
operationId: discussion/locked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-locked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-pinned:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was pinned.
operationId: discussion/pinned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-pinned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-reopened:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was reopened.
operationId: discussion/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: discussions
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.9.0
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-transferred:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was transferred to another repository.
operationId: discussion/transferred
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-transferred'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-unanswered:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A comment on the discussion was unmarked as the answer.
operationId: discussion/unanswered
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-unanswered'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-unlabeled:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A label was removed from a discussion.
operationId: discussion/unlabeled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-unlabeled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-unlocked:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was unlocked.
operationId: discussion/unlocked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-unlocked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
discussion-unpinned:
post:
summary: 'This event occurs when there is activity relating to a discussion. For more information about discussions, see "[GitHub Discussions](https://docs.github.com/enterprise-server@3.9/discussions)." For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#discussion).
For activity relating to a comment on a discussion, use the `discussion_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Discussions" repository permission.
**Note**: Webhook events for GitHub Discussions are currently in beta and subject to change.'
description: A discussion was unpinned.
operationId: discussion/unpinned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#discussion
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-discussion-unpinned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: discussion
supported-webhook-types:
- repository
- organization
- app
enterprise-anonymous-access-disabled:
post:
summary: This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)."
description: Anonymous Git read access was disabled.
operationId: enterprise/anonymous-access-disabled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#enterprise
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-enterprise-anonymous-access-disabled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: enterprise
supported-webhook-types:
- business
enterprise-anonymous-access-enabled:
post:
summary: This event occurs when there is activity relating to anonymous Git read access in an enterprise. For more information, see "[Enforcing repository management policies in your enterprise](https://docs.github.com/enterprise-server@3.9/admin/policies/enforcing-policies-for-your-enterprise/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)."
description: Anonymous Git read access was enabled.
operationId: enterprise/anonymous-access-enabled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#enterprise
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-enterprise-anonymous-access-enabled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: enterprise
supported-webhook-types:
- business
fork:
post:
summary: 'This event occurs when someone forks a repository. For more information, see "[Fork a repo](https://docs.github.com/enterprise-server@3.9/get-started/quickstart/fork-a-repo)." For information about the API to manage forks, see "[Forks](https://docs.github.com/enterprise-server@3.9/rest/repos/forks)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
operationId: fork
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#fork
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-fork'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: fork
supported-webhook-types:
- business
- repository
- organization
- app
github-app-authorization-revoked:
post:
summary: 'This event occurs when a user revokes their authorization of a GitHub App. For more information, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the API to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.
A GitHub App receives this webhook by default and cannot unsubscribe from this event.
Anyone can revoke their authorization of a GitHub App from their [GitHub account settings page](https://github.com/settings/apps/authorizations). Revoking the authorization of a GitHub App does not uninstall the GitHub App. You should program your GitHub App so that when it receives this webhook, it stops calling the API on behalf of the person who revoked the token. If your GitHub App continues to use a revoked access token, it will receive the `401 Bad Credentials` error. For details about requests with a user access token, which require GitHub App authorization, see "[Authenticating with a GitHub App on behalf of a user](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/authenticating-with-a-github-app/authenticating-with-a-github-app-on-behalf-of-a-user)."'
description: Someone revoked their authorization of a GitHub App.
operationId: github-app-authorization/revoked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#github_app_authorization
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-github-app-authorization-revoked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: github_app_authorization
supported-webhook-types:
- app
gollum:
post:
summary: 'This event occurs when someone creates or updates a wiki page. For more information, see "[About wikis](https://docs.github.com/enterprise-server@3.9/communities/documenting-your-project-with-wikis/about-wikis)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
operationId: gollum
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#gollum
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-gollum'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: gollum
supported-webhook-types:
- repository
- organization
- app
installation-created:
post:
summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: Someone installed a GitHub App on a user or organization account.
operationId: installation/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation
supported-webhook-types:
- app
installation-deleted:
post:
summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: Someone uninstalled a GitHub App from their user or organization account.
operationId: installation/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation
supported-webhook-types:
- app
installation-new-permissions-accepted:
post:
summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: Someone granted new permissions to a GitHub App.
operationId: installation/new-permissions-accepted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-new-permissions-accepted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation
supported-webhook-types:
- app
installation-repositories-added:
post:
summary: 'This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: A GitHub App installation was granted access to one or more repositories.
operationId: installation-repositories/added
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_repositories
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-repositories-added'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation_repositories
supported-webhook-types:
- app
installation-repositories-removed:
post:
summary: 'This event occurs when there is activity relating to which repositories a GitHub App installation can access. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: Access to one or more repositories was revoked for a GitHub App installation.
operationId: installation-repositories/removed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_repositories
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-repositories-removed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation_repositories
supported-webhook-types:
- app
installation-suspend:
post:
summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: Someone blocked access by a GitHub App to their user or organization account.
operationId: installation/suspend
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-suspend'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation
supported-webhook-types:
- app
installation-target-renamed:
post:
summary: This event occurs when there is activity relating to the user or organization account that a GitHub App is installed on. For more information, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.
description: Somebody renamed the user or organization account that a GitHub App is installed on.
operationId: installation-target/renamed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation_target
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-target-renamed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation_target
supported-webhook-types:
- app
installation-unsuspend:
post:
summary: 'This event occurs when there is activity relating to a GitHub App installation. All GitHub Apps receive this event by default. You cannot manually subscribe to this event.
For more information about GitHub Apps, see "[About apps](https://docs.github.com/enterprise-server@3.9/developers/apps/getting-started-with-apps/about-apps#about-github-apps)." For information about the APIs to manage GitHub Apps, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#app) or "[Apps](https://docs.github.com/enterprise-server@3.9/rest/apps)" in the REST API documentation.'
description: A GitHub App that was blocked from accessing a user or organization account was given access the account again.
operationId: installation/unsuspend
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#installation
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-installation-unsuspend'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: installation
supported-webhook-types:
- app
issue-comment-created:
post:
summary: 'This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)" in the REST API documentation.
For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A comment on an issue or pull request was created.
operationId: issue-comment/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issue-comment-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issue_comment
supported-webhook-types:
- repository
- organization
- app
issue-comment-deleted:
post:
summary: 'This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)" in the REST API documentation.
For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A comment on an issue or pull request was deleted.
operationId: issue-comment/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issue-comment-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issue_comment
supported-webhook-types:
- repository
- organization
- app
issue-comment-edited:
post:
summary: 'This event occurs when there is activity relating to a comment on an issue or pull request. For more information about issues and pull requests, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)" and "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage issue comments, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issuecomment) or "[Issue comments](https://docs.github.com/enterprise-server@3.9/rest/issues/comments)" in the REST API documentation.
For activity relating to an issue as opposed to comments on an issue, use the `issue` event. For activity related to pull request reviews or pull request review comments, use the `pull_request_review` or `pull_request_review_comment` events. For more information about the different types of pull request comments, see "[Working with comments](https://docs.github.com/enterprise-server@3.9/rest/guides/working-with-comments)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A comment on an issue or pull request was edited.
operationId: issue-comment/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issue_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issue-comment-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issue_comment
supported-webhook-types:
- repository
- organization
- app
issues-assigned:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was assigned to a user.
operationId: issues/assigned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-assigned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-closed:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was closed.
operationId: issues/closed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-closed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-deleted:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was deleted.
operationId: issues/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-demilestoned:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was removed from a milestone.
operationId: issues/demilestoned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-demilestoned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-edited:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: The title or body on an issue was edited.
operationId: issues/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-labeled:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A label was added to an issue.
operationId: issues/labeled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-labeled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-locked:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: issues/locked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-locked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-milestoned:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was added to a milestone.
operationId: issues/milestoned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-milestoned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-opened:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was created. When a closed issue is reopened, the action will be `reopened` instead.
operationId: issues/opened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-opened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-pinned:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was pinned to a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
operationId: issues/pinned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-pinned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-reopened:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A closed issue was reopened.
operationId: issues/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-transferred:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was transferred to another repository. For more information, see "[Transferring an issue to another repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository)."
operationId: issues/transferred
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-transferred'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-unassigned:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A user was unassigned from an issue.
operationId: issues/unassigned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-unassigned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-unlabeled:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: A label was removed from an issue.
operationId: issues/unlabeled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-unlabeled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-unlocked:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: Conversation on an issue was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: issues/unlocked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-unlocked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
issues-unpinned:
post:
summary: 'This event occurs when there is activity relating to an issue. For more information about issues, see "[About issues](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/about-issues)." For information about the APIs to manage issues, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#issue) or "[Issues](https://docs.github.com/enterprise-server@3.9/rest/issues)" in the REST API documentation.
For activity relating to a comment on an issue, use the `issue_comment` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" repository permission.'
description: An issue was unpinned from a repository. For more information, see "[Pinning an issue to your repository](https://docs.github.com/enterprise-server@3.9/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository)."
operationId: issues/unpinned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#issues
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-issues-unpinned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: issues
supported-webhook-types:
- repository
- organization
- app
label-created:
post:
summary: 'This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A label was created.
operationId: label/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-label-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: label
supported-webhook-types:
- repository
- organization
- app
label-deleted:
post:
summary: 'This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A label was deleted.
operationId: label/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-label-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: label
supported-webhook-types:
- repository
- organization
- app
label-edited:
post:
summary: 'This event occurs when there is activity relating to labels. For more information, see "[Managing labels](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/managing-labels)." For information about the APIs to manage labels, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#label) or "[Labels](https://docs.github.com/enterprise-server@3.9/rest/issues/labels)" in the REST API documentation.
If you want to receive an event when a label is added to or removed from an issue, pull request, or discussion, use the `labeled` or `unlabeled` action type for the `issues`, `pull_request`, or `discussion` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A label's name, description, or color was changed.
operationId: label/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#label
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-label-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: label
supported-webhook-types:
- repository
- organization
- app
member-added:
post:
summary: 'This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A GitHub user accepted an invitation to a repository.
operationId: member/added
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-member-added'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: member
supported-webhook-types:
- business
- repository
- organization
- app
member-edited:
post:
summary: 'This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: Permissions were changed for a collaborator on a repository.
operationId: member/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-member-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: member
supported-webhook-types:
- business
- repository
- organization
- app
member-removed:
post:
summary: 'This event occurs when there is activity relating to collaborators in a repository. For more information, see "[Adding outside collaborators to repositories in your organization](https://docs.github.com/enterprise-server@3.9/organizations/managing-user-access-to-your-organizations-repositories/adding-outside-collaborators-to-repositories-in-your-organization)." For more information about the API to manage repository collaborators, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repositorycollaboratorconnection) or "[Collaborators](https://docs.github.com/enterprise-server@3.9/rest/collaborators/collaborators)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A collaborator was removed from a repository.
operationId: member/removed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#member
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-member-removed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: member
supported-webhook-types:
- business
- repository
- organization
- app
membership-added:
post:
summary: 'This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.9/rest/teams/members)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: An organization member was added to a team.
operationId: membership/added
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#membership
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-membership-added'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: membership
supported-webhook-types:
- organization
- business
- app
membership-removed:
post:
summary: 'This event occurs when there is activity relating to team membership. For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)." For more information about the APIs to manage team memberships, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#team) or "[Team members](https://docs.github.com/enterprise-server@3.9/rest/teams/members)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: An organization member was removed from a team.
operationId: membership/removed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#membership
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-membership-removed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: membership
supported-webhook-types:
- organization
- business
- app
meta-deleted:
post:
summary: 'This event occurs when there is activity relating to a webhook itself.
To subscribe to this event, a GitHub App must have at least read-level access for the "Meta" app permission.'
description: The webhook was deleted.
operationId: meta/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#meta
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-meta-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: meta
supported-webhook-types:
- marketplace
- business
- repository
- organization
- app
milestone-closed:
post:
summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.'
description: A milestone was closed.
operationId: milestone/closed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-milestone-closed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: milestone
supported-webhook-types:
- repository
- organization
- app
milestone-created:
post:
summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.'
description: A milestone was created.
operationId: milestone/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-milestone-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: milestone
supported-webhook-types:
- repository
- organization
- app
milestone-deleted:
post:
summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.'
description: A milestone was deleted.
operationId: milestone/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-milestone-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: milestone
supported-webhook-types:
- repository
- organization
- app
milestone-edited:
post:
summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.'
description: A milestone was edited.
operationId: milestone/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-milestone-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: milestone
supported-webhook-types:
- repository
- organization
- app
milestone-opened:
post:
summary: 'This event occurs when there is activity relating to milestones. For more information, see "[About milestones](https://docs.github.com/enterprise-server@3.9/issues/using-labels-and-milestones-to-track-work/about-milestones)." For information about the APIs to manage milestones, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#milestone) or "[Milestones](https://docs.github.com/enterprise-server@3.9/rest/issues/milestones)" in the REST API documentation.
If you want to receive an event when an issue or pull request is added to or removed from a milestone, use the `milestoned` or `demilestoned` action type for the `issues` or `pull_request` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Issues" or "Pull requests" repository permissions.'
description: A milestone was opened.
operationId: milestone/opened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#milestone
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-milestone-opened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: milestone
supported-webhook-types:
- repository
- organization
- app
organization-deleted:
post:
summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: An organization was deleted.
operationId: organization/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-organization-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: organization
supported-webhook-types:
- organization
- business
- app
organization-member-added:
post:
summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A member accepted an invitation to join an organization.
operationId: organization/member-added
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-organization-member-added'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: organization
supported-webhook-types:
- organization
- business
- app
organization-member-invited:
post:
summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A member was invited to join the organization.
operationId: organization/member-invited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-organization-member-invited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: organization
supported-webhook-types:
- organization
- business
- app
organization-member-removed:
post:
summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A member was removed from the organization.
operationId: organization/member-removed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-organization-member-removed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: organization
supported-webhook-types:
- organization
- business
- app
organization-renamed:
post:
summary: 'This event occurs when there is activity relating to an organization and its members. For more information, see "[About organizations](https://docs.github.com/enterprise-server@3.9/organizations/collaborating-with-groups-in-organizations/about-organizations)." For information about the APIs to manage organizations, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#organization) or "[Organizations](https://docs.github.com/enterprise-server@3.9/rest/orgs)" in the REST API documentation.
If you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: The name of an organization was changed.
operationId: organization/renamed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#organization
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-organization-renamed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: organization
supported-webhook-types:
- organization
- business
- app
package-published:
post:
summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.'
description: A package was published to a registry.
operationId: package/published
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#package
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-package-published'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: package
supported-webhook-types:
- repository
- organization
- app
package-updated:
post:
summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.'
description: A previously published package was updated.
operationId: package/updated
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#package
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-package-updated'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: package
supported-webhook-types:
- repository
- organization
- app
page-build:
post:
summary: 'This event occurs when there is an attempted build of a GitHub Pages site. This event occurs regardless of whether the build is successful. For more information, see "[Configuring a publishing source for your GitHub Pages site](https://docs.github.com/enterprise-server@3.9/pages/getting-started-with-github-pages/configuring-a-publishing-source-for-your-github-pages-site)." For information about the API to manage GitHub Pages, see "[Pages](https://docs.github.com/enterprise-server@3.9/rest/pages)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pages" repository permission.'
operationId: page-build
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#page_build
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-page-build'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: page_build
supported-webhook-types:
- repository
- organization
- app
ping:
post:
summary: This event occurs when you create a new webhook. The ping event is a confirmation from GitHub that you configured the webhook correctly.
operationId: ping
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#ping
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-ping'
examples:
default:
$ref: '#/components/examples/ping'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-ping-form-encoded'
examples:
default:
$ref: '#/components/examples/ping-form-encoded'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: ping
supported-webhook-types:
- repository
- organization
- app
- business
- marketplace
project-card-converted:
post:
summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A note in a project (classic) was converted to an issue.
operationId: project-card/converted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-card-converted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_card
supported-webhook-types:
- repository
- organization
- app
project-card-created:
post:
summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A card was added to a project (classic).
operationId: project-card/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-card-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_card
supported-webhook-types:
- repository
- organization
- app
project-card-deleted:
post:
summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A card on a project (classic) was deleted.
operationId: project-card/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-card-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_card
supported-webhook-types:
- repository
- organization
- app
project-card-edited:
post:
summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A note on a project (classic) was edited.
operationId: project-card/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-card-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_card
supported-webhook-types:
- repository
- organization
- app
project-card-moved:
post:
summary: 'This event occurs when there is activity relating to a card on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A card on a project (classic) was moved to another column or to another position in its column.
operationId: project-card/moved
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_card
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-card-moved'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_card
supported-webhook-types:
- repository
- organization
- app
project-closed:
post:
summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A project (classic) was closed.
operationId: project/closed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-closed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project
supported-webhook-types:
- repository
- organization
- app
project-column-created:
post:
summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A column was added to a project (classic).
operationId: project-column/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-column-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_column
supported-webhook-types:
- repository
- organization
- app
project-column-deleted:
post:
summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A column was deleted from a project (classic).
operationId: project-column/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-column-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_column
supported-webhook-types:
- repository
- organization
- app
project-column-edited:
post:
summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: The name of a column on a project (classic) was changed.
operationId: project-column/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-column-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_column
supported-webhook-types:
- repository
- organization
- app
project-column-moved:
post:
summary: 'This event occurs when there is activity relating to a column on a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A column was moved to a new position on a project (classic).
operationId: project-column/moved
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project_column
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-column-moved'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project_column
supported-webhook-types:
- repository
- organization
- app
project-created:
post:
summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A project (classic) was created.
operationId: project/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project
supported-webhook-types:
- repository
- organization
- app
project-deleted:
post:
summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A project (classic) was deleted.
operationId: project/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project
supported-webhook-types:
- repository
- organization
- app
project-edited:
post:
summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: The name or description of a project (classic) was changed.
operationId: project/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project
supported-webhook-types:
- repository
- organization
- app
project-reopened:
post:
summary: 'This event occurs when there is activity relating to a project (classic). For more information, see "[About projects (classic)](https://docs.github.com/enterprise-server@3.9/issues/organizing-your-work-with-project-boards/managing-project-boards/about-project-boards)." For information about the API to manage classic projects, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#project) or "[Projects (classic)](https://docs.github.com/enterprise-server@3.9/rest/projects)" in the REST API documentation.
For activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.
This event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" repository or organization permission.'
description: A project (classic) was closed.
operationId: project/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#project
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-project-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: project
supported-webhook-types:
- repository
- organization
- app
projects-v2-closed:
post:
summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).
For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: A project in the organization was closed.
operationId: projects-v2/closed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-project-closed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2
supported-webhook-types:
- organization
projects-v2-created:
post:
summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).
For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: A project in the organization was created.
operationId: projects-v2/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-project-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2
supported-webhook-types:
- organization
projects-v2-deleted:
post:
summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).
For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: A project in the organization was deleted.
operationId: projects-v2/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-project-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2
supported-webhook-types:
- organization
projects-v2-edited:
post:
summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).
For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: The title, description, or README of a project in the organization was changed.
operationId: projects-v2/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-project-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2
supported-webhook-types:
- organization
projects-v2-item-archived:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: An item on an organization project was archived. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
operationId: projects-v2-item/archived
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-archived'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-item-converted:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: A draft issue in an organization project was converted to an issue.
operationId: projects-v2-item/converted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-converted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-item-created:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: An item was added to a project in the organization.
operationId: projects-v2-item/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-item-deleted:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: An item was deleted from a project in the organization.
operationId: projects-v2-item/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-item-edited:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: The values or state of an item in an organization project were changed. For example, the value of a field was updated, the body of a draft issue was changed, or a draft issue was converted to an issue.
operationId: projects-v2-item/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-item-reordered:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: The position of an item in an organization project was changed. For example, an item was moved above or below another item in the table or board layout.
operationId: projects-v2-item/reordered
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-reordered'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-item-restored:
post:
summary: 'This event occurs when there is activity relating to an item on an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2item).
For activity relating to a project (instead of an item on a project), use the `projects_v2` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: An archived item on an organization project was restored from the archive. For more information, see "[Archiving items from your project](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/managing-items-in-your-project/archiving-items-from-your-project)."
operationId: projects-v2-item/restored
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2_item
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2-item
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-item-restored'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2_item
supported-webhook-types:
- organization
projects-v2-reopened:
post:
summary: 'This event occurs when there is activity relating to an organization-level project. For more information, see "[About Projects](https://docs.github.com/enterprise-server@3.9/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects)." For information about the Projects API, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#projectv2).
For activity relating to a item on a project, use the `projects_v2_item` event. For activity relating to Projects (classic), use the `project`, `project_card`, and `project_column` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Projects" organization permission.
**Note**: Webhook events for projects are currently in beta and subject to change. To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).'
description: A project in the organization was reopened.
operationId: projects-v2/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#projects_v2
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: project-v2
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-projects-v2-project-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: projects_v2
supported-webhook-types:
- organization
public:
post:
summary: 'This event occurs when repository visibility changes from private to public. For more information, see "[Setting repository visibility](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
operationId: public
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#public
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-public'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: public
supported-webhook-types:
- repository
- organization
- app
pull-request-assigned:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request was assigned to a user.
operationId: pull-request/assigned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-assigned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-auto-merge-disabled:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: Auto merge was disabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
operationId: pull-request/auto-merge-disabled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-auto-merge-disabled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-auto-merge-enabled:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: Auto merge was enabled for a pull request. For more information, see "[Automatically merging a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/automatically-merging-a-pull-request)."
operationId: pull-request/auto-merge-enabled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-auto-merge-enabled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-closed:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request was closed. If `merged` is false in the webhook payload, the pull request was closed with unmerged commits. If `merged` is true in the webhook payload, the pull request was merged.
operationId: pull-request/closed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-closed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-converted-to-draft:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request was converted to a draft. For more information, see "[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
operationId: pull-request/converted-to-draft
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-converted-to-draft'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-demilestoned:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request was removed from a milestone.
operationId: pull-request/demilestoned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-demilestoned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-edited:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: The title or body of a pull request was edited, or the base branch of a pull request was changed.
operationId: pull-request/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-labeled:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A label was added to a pull request.
operationId: pull-request/labeled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-labeled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-locked:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: Conversation on a pull request was locked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: pull-request/locked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-locked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-milestoned:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request was added to a milestone.
operationId: pull-request/milestoned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-milestoned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-opened:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request was created
operationId: pull-request/opened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-opened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-ready-for-review:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A draft pull request was marked as ready for review. For more information, see "[Changing the stage of a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/changing-the-stage-of-a-pull-request)."
operationId: pull-request/ready-for-review
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-ready-for-review'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-reopened:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A previously closed pull request was reopened.
operationId: pull-request/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-review-comment-created:
post:
summary: 'This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request''s diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A comment on a pull request diff was created.
operationId: pull-request-review-comment/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-comment-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
- app
pull-request-review-comment-deleted:
post:
summary: 'This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request''s diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A comment on a pull request diff was deleted.
operationId: pull-request-review-comment/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-comment-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
- app
pull-request-review-comment-edited:
post:
summary: 'This event occurs when there is activity relating to a pull request review comment. A pull request review comment is a comment on a pull request''s diff. For more information, see "[Commenting on a pull request](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/commenting-on-a-pull-request#adding-line-comments-to-a-pull-request)." For information about the APIs to manage pull request review comments, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewcomment) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation.
For activity related to pull request reviews, pull request comments, or pull request review threads, use the `pull_request_review`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: The content of a comment on a pull request diff was changed.
operationId: pull-request-review-comment/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_comment
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-comment-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review_comment
supported-webhook-types:
- repository
- organization
- app
pull-request-review-dismissed:
post:
summary: 'This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A review on a pull request was dismissed.
operationId: pull-request-review/dismissed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-dismissed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
- app
pull-request-review-edited:
post:
summary: 'This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: The body comment on a pull request review was edited.
operationId: pull-request-review/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
- app
pull-request-review-request-removed:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A request for review by a person or team was removed from a pull request.
operationId: pull-request/review-request-removed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-request-removed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-review-requested:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: Review by a person or team was requested for a pull request. For more information, see "[Requesting a pull request review](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/requesting-a-pull-request-review)."
operationId: pull-request/review-requested
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-requested'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-review-submitted:
post:
summary: 'This event occurs when there is activity relating to a pull request review. A pull request review is a group of pull request review comments in addition to a body comment and a state. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreview) or "[Pull request reviews](https://docs.github.com/enterprise-server@3.9/rest/pulls/reviews)" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A review on a pull request was submitted.
operationId: pull-request-review/submitted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-submitted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review
supported-webhook-types:
- repository
- organization
- app
pull-request-review-thread-resolved:
post:
summary: 'This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A comment thread on a pull request was marked as resolved.
operationId: pull-request-review-thread/resolved
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_thread
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-thread-resolved'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review_thread
supported-webhook-types:
- repository
- organization
- app
pull-request-review-thread-unresolved:
post:
summary: 'This event occurs when there is activity relating to a comment thread on a pull request. For more information, see "[About pull request reviews](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/about-pull-request-reviews)." For information about the APIs to manage pull request reviews, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequestreviewthread) or "[Pull request review comments](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments)" in the REST API documentation.
For activity related to pull request review comments, pull request comments, or pull request reviews, use the `pull_request_review_comment`, `issue_comment`, or `pull_request_review` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A previously resolved comment thread on a pull request was marked as unresolved.
operationId: pull-request-review-thread/unresolved
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request_review_thread
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-review-thread-unresolved'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request_review_thread
supported-webhook-types:
- repository
- organization
- app
pull-request-synchronize:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A pull request's head branch was updated. For example, the head branch was updated from the base branch or new commits were pushed to the head branch.
operationId: pull-request/synchronize
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-synchronize'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-unassigned:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A user was unassigned from a pull request.
operationId: pull-request/unassigned
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-unassigned'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-unlabeled:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: A label was removed from a pull request.
operationId: pull-request/unlabeled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-unlabeled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
pull-request-unlocked:
post:
summary: 'This event occurs when there is activity on a pull request. For more information, see "[About pull requests](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)." For information about the APIs to manage pull requests, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#pullrequest) or "[Pulls](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls)" in the REST API documentation.
For activity related to pull request reviews, pull request review comments, pull request comments, or pull request review threads, use the `pull_request_review`, `pull_request_review_comment`, `issue_comment`, or `pull_request_review_thread` events instead.
To subscribe to this event, a GitHub App must have at least read-level access for the "Pull requests" repository permission.'
description: Conversation on a pull request was unlocked. For more information, see "[Locking conversations](https://docs.github.com/enterprise-server@3.9/communities/moderating-comments-and-conversations/locking-conversations)."
operationId: pull-request/unlocked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#pull_request
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-pull-request-unlocked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: pull_request
supported-webhook-types:
- repository
- organization
- app
push:
post:
summary: 'This event occurs when there is a push to a repository branch. This includes when a commit is pushed, when a commit tag is pushed,
when a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch
and tag deletions, use the [`delete`](#delete) webhook event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.
**Note**: An event will not be created when more than three tags are pushed at once.'
operationId: push
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#push
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-push'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: push
supported-webhook-types:
- repository
- organization
- app
registry-package-published:
post:
summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
**Note**: GitHub recommends that you use the newer `package` event instead.'
description: A package was published to a registry.
operationId: registry-package/published
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#registry_package
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-registry-package-published'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: registry_package
supported-webhook-types:
- repository
- organization
- app
registry-package-updated:
post:
summary: 'This event occurs when there is activity relating to GitHub Packages. For more information, see "[Introduction to GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/introduction-to-github-packages)." For information about the APIs to manage GitHub Packages, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#package) or "[Packages](https://docs.github.com/enterprise-server@3.9/rest/packages)" in the REST API documentation.
To install this event on a GitHub App, the app must have at least read-level access for the "Packages" repository permission.
**Note**: GitHub recommends that you use the newer `package` event instead.'
description: A package that was previously published to a registry was updated.
operationId: registry-package/updated
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#registry_package
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-registry-package-updated'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: registry_package
supported-webhook-types:
- repository
- organization
- app
release-created:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: A draft was saved, or a release or pre-release was published without previously being saved as a draft.
operationId: release/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
release-deleted:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: A release, pre-release, or draft release was deleted.
operationId: release/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
release-edited:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: The details of a release, pre-release, or draft release were edited. For more information, see "[Managing releases in a repository](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release)."
operationId: release/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
release-prereleased:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: A release was created and identified as a pre-release. A pre-release is a release that is not ready for production and may be unstable.
operationId: release/prereleased
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-prereleased'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
release-published:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: A release, pre-release, or draft of a release was published.
operationId: release/published
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-published'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
release-released:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: A release was published, or a pre-release was changed to a release.
operationId: release/released
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-released'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
release-unpublished:
post:
summary: 'This event occurs when there is activity relating to releases. For more information, see "[About releases](https://docs.github.com/enterprise-server@3.9/repositories/releasing-projects-on-github/about-releases)." For information about the APIs to manage releases, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#release) or "[Releases](https://docs.github.com/enterprise-server@3.9/rest/releases)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: A release or pre-release was unpublished.
operationId: release/unpublished
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#release
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-release-unpublished'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: release
supported-webhook-types:
- repository
- organization
- app
repository-anonymous-access-disabled:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: Someone disabled anonymous Git read access to the repository. For more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)."
operationId: repository/anonymous-access-disabled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-anonymous-access-disabled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- app
- business
- organization
- repository
repository-anonymous-access-enabled:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: Someone enabled anonymous Git read access to the repository. For more information, see "[Enabling anonymous Git read access for a repository](/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/enabling-anonymous-git-read-access-for-a-repository)."
operationId: repository/anonymous-access-enabled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-anonymous-access-enabled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- app
- business
- organization
- repository
repository-archived:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A repository was archived.
operationId: repository/archived
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-archived'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-created:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A repository was created.
operationId: repository/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-deleted:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A repository was deleted. GitHub Apps and repository webhooks will not receive this event.
operationId: repository/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-dispatch-sample.collected:
post:
summary: 'This event occurs when a GitHub App sends a `POST` request to `/repos/{owner}/{repo}/dispatches`. For more information, see [the REST API documentation for creating a repository dispatch event](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-dispatch-event).
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
description: The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.
operationId: repository-dispatch/sample.collected
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_dispatch
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-dispatch-sample'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository_dispatch
supported-webhook-types:
- app
repository-edited:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: The topics, default branch, description, or homepage of a repository was changed.
operationId: repository/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-privatized:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: The visibility of a repository was changed to `private`.
operationId: repository/privatized
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-privatized'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-publicized:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: The visibility of a repository was changed to `public`.
operationId: repository/publicized
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-publicized'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-renamed:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: The name of a repository was changed.
operationId: repository/renamed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-renamed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-transferred:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: Ownership of the repository was transferred to a user or organization account. This event is only sent to the account where the ownership is transferred. To receive the `repository.transferred` event, the new owner account must have the GitHub App installed, and the App must be subscribed to "Repository" events.
operationId: repository/transferred
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-transferred'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-unarchived:
post:
summary: 'This event occurs when there is activity relating to repositories. For more information, see "[About repositories](https://docs.github.com/enterprise-server@3.9/repositories/creating-and-managing-repositories/about-repositories)." For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#repository) or "[Repositories](https://docs.github.com/enterprise-server@3.9/rest/repos)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: A previously archived repository was unarchived.
operationId: repository/unarchived
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-unarchived'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository
supported-webhook-types:
- business
- repository
- organization
- app
repository-vulnerability-alert-create:
post:
summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository.
**Note**: This event is deprecated. Use the `dependabot_alert` event instead.'
description: A repository vulnerability alert was created.
operationId: repository-vulnerability-alert/create
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-vulnerability-alert-create'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
repository-vulnerability-alert-dismiss:
post:
summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository.
**Note**: This event is deprecated. Use the `dependabot_alert` event instead.'
description: A repository vulnerability alert was dismissed.
operationId: repository-vulnerability-alert/dismiss
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-vulnerability-alert-dismiss'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
repository-vulnerability-alert-reopen:
post:
summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository.
**Note**: This event is deprecated. Use the `dependabot_alert` event instead.'
description: A previously dismissed or resolved repository vulnerability alert was reopened.
operationId: repository-vulnerability-alert/reopen
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-vulnerability-alert-reopen'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
repository-vulnerability-alert-resolve:
post:
summary: 'This event occurs when there is activity relating to a security vulnerability alert in a repository.
**Note**: This event is deprecated. Use the `dependabot_alert` event instead.'
description: A repository vulnerability alert was marked as resolved.
operationId: repository-vulnerability-alert/resolve
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#repository_vulnerability_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-repository-vulnerability-alert-resolve'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: repository_vulnerability_alert
supported-webhook-types:
- repository
- organization
secret-scanning-alert-created:
post:
summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation.
For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.'
description: A secret scanning alert was created.
operationId: secret-scanning-alert/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-secret-scanning-alert-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
- app
secret-scanning-alert-location-created:
post:
summary: 'This event occurs when there is activity relating to the locations of a secret in a secret scanning alert.
For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation.
For activity relating to secret scanning alerts, use the `secret_scanning_alert` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.'
description: A new instance of a previously detected secret was detected in a repository, and the location of the secret was added to the existing alert.
operationId: secret-scanning-alert-location/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert_location
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-secret-scanning-alert-location-created'
examples:
default:
$ref: '#/components/examples/secret-scanning-alert-location-created'
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/webhook-secret-scanning-alert-location-created-form-encoded'
examples:
default:
$ref: '#/components/examples/secret-scanning-alert-location-created-form-encoded'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
enabledForGitHubApps: true
category: webhooks
subcategory: secret_scanning_alert_location
supported-webhook-types:
- repository
- organization
- app
secret-scanning-alert-reopened:
post:
summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation.
For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.'
description: A previously closed secret scanning alert was reopened.
operationId: secret-scanning-alert/reopened
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-secret-scanning-alert-reopened'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
- app
secret-scanning-alert-resolved:
post:
summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation.
For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.'
description: A secret scanning alert was closed.
operationId: secret-scanning-alert/resolved
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-secret-scanning-alert-resolved'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
- app
secret-scanning-alert-revoked:
post:
summary: 'This event occurs when there is activity relating to a secret scanning alert. For more information about secret scanning, see "[About secret scanning](https://docs.github.com/enterprise-server@3.9/code-security/secret-scanning/about-secret-scanning)." For information about the API to manage secret scanning alerts, see "[Secret scanning](https://docs.github.com/enterprise-server@3.9/rest/secret-scanning)" in the REST API documentation.
For activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Secret scanning alerts" repository permission.'
description: A secret scanning alert was marked as revoked.
operationId: secret-scanning-alert/revoked
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#secret_scanning_alert
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-secret-scanning-alert-revoked'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: secret_scanning_alert
supported-webhook-types:
- repository
- organization
- app
security-advisory-published:
post:
summary: 'This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#securityadvisory).
GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."'
description: A security advisory was published to the GitHub community.
operationId: security-advisory/published
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-security-advisory-published'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: security_advisory
supported-webhook-types:
- app
security-advisory-updated:
post:
summary: 'This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#securityadvisory).
GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."'
description: The metadata or description of a security advisory was changed.
operationId: security-advisory/updated
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-security-advisory-updated'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: security_advisory
supported-webhook-types:
- app
security-advisory-withdrawn:
post:
summary: 'This event occurs when there is activity relating to a global security advisory that was reviewed by GitHub. A GitHub-reviewed global security advisory provides information about security vulnerabilities or malware that have been mapped to packages in ecosystems we support. For more information about global security advisories, see "[About global security advisories](https://docs.github.com/enterprise-server@3.9/code-security/security-advisories/working-with-global-security-advisories-from-the-github-advisory-database/about-global-security-advisories)." For information about the API to manage security advisories, see [the REST API documentation](https://docs.github.com/enterprise-server@3.9/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#securityadvisory).
GitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see "[About Dependabot alerts](https://docs.github.com/enterprise-server@3.9/code-security/dependabot/dependabot-alerts/about-dependabot-alerts)."'
description: A previously published security advisory was withdrawn.
operationId: security-advisory/withdrawn
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_advisory
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-security-advisory-withdrawn'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: security_advisory
supported-webhook-types:
- app
security-and-analysis:
post:
summary: 'This event occurs when code security and analysis features are enabled or disabled for a repository. For more information, see "[GitHub security features](https://docs.github.com/enterprise-server@3.9/code-security/getting-started/github-security-features)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Administration" repository permission.'
operationId: security-and-analysis
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#security_and_analysis
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-security-and-analysis'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: security_and_analysis
supported-webhook-types:
- repository
- organization
- app
sponsorship-cancelled:
post:
summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship).
You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."'
description: 'A sponsorship was cancelled and the last billing cycle has ended.
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.'
operationId: sponsorship/cancelled
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-sponsorship-cancelled'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: sponsorship
supported-webhook-types:
- sponsors_listing
sponsorship-created:
post:
summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship).
You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."'
description: A sponsor created a sponsorship for a sponsored account. This event occurs once the payment is successfully processed.
operationId: sponsorship/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-sponsorship-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: sponsorship
supported-webhook-types:
- sponsors_listing
sponsorship-edited:
post:
summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship).
You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."'
description: A monthly sponsor changed who can see their sponsorship. If you recognize your sponsors publicly, you may want to update your sponsor recognition to reflect the change when this event occurs.
operationId: sponsorship/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-sponsorship-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: sponsorship
supported-webhook-types:
- sponsors_listing
sponsorship-pending-cancellation:
post:
summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship).
You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."'
description: 'A sponsor scheduled a cancellation for their sponsorship. The cancellation will become effective on their next billing date.
This event is only sent when a recurring (monthly) sponsorship is cancelled; it is not sent for one-time sponsorships.'
operationId: sponsorship/pending-cancellation
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-sponsorship-pending-cancellation'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: sponsorship
supported-webhook-types:
- sponsors_listing
sponsorship-pending-tier-change:
post:
summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship).
You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."'
description: A sponsor scheduled a downgrade to a lower sponsorship tier. The new tier will become effective on their next billing date.
operationId: sponsorship/pending-tier-change
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-sponsorship-pending-tier-change'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: sponsorship
supported-webhook-types:
- sponsors_listing
sponsorship-tier-changed:
post:
summary: 'This event occurs when there is activity relating to a sponsorship listing. For more information, see "[About GitHub Sponsors](https://docs.github.com/enterprise-server@3.9/sponsors/getting-started-with-github-sponsors/about-github-sponsors)." For information about the API to manage sponsors, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#sponsorship).
You can only create a sponsorship webhook on GitHub.com. For more information, see "[Configuring webhooks for events in your sponsored account](https://docs.github.com/enterprise-server@3.9/sponsors/integrating-with-github-sponsors/configuring-webhooks-for-events-in-your-sponsored-account)."'
description: A sponsor changed the tier of their sponsorship and the change has taken effect. If a sponsor upgraded their tier, the change took effect immediately. If a sponsor downgraded their tier, the change took effect at the beginning of the sponsor's next billing cycle.
operationId: sponsorship/tier-changed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#sponsorship
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-sponsorship-tier-changed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: sponsorship
supported-webhook-types:
- sponsors_listing
star-created:
post:
summary: 'This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-server@3.9/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.9/rest/activity/starring)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: Someone starred a repository.
operationId: star/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#star
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-star-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: star
supported-webhook-types:
- repository
- organization
- app
star-deleted:
post:
summary: 'This event occurs when there is activity relating to repository stars. For more information about stars, see "[Saving repositories with stars](https://docs.github.com/enterprise-server@3.9/get-started/exploring-projects-on-github/saving-repositories-with-stars)." For information about the APIs to manage stars, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#starredrepositoryconnection) or "[Starring](https://docs.github.com/enterprise-server@3.9/rest/activity/starring)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: Someone unstarred the repository.
operationId: star/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#star
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-star-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: star
supported-webhook-types:
- repository
- organization
- app
status:
post:
summary: 'This event occurs when the status of a Git commit changes. For example, commits can be marked as `error`, `failure`, `pending`, or `success`. For more information, see "[About status checks](https://docs.github.com/enterprise-server@3.9/pull-requests/collaborating-with-pull-requests/collaborating-on-repositories-with-code-quality-features/about-status-checks)." For information about the APIs to manage commit statuses, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#status) or "[Commit statuses](https://docs.github.com/enterprise-server@3.9/rest/commits/statuses)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Commit statuses" repository permission.'
operationId: status
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#status
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-status'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: status
supported-webhook-types:
- repository
- organization
- app
team-add:
post:
summary: 'This event occurs when a team is added to a repository.
For more information, see "[Managing teams and people with access to your repository](https://docs.github.com/enterprise-server@3.9/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository)."
For activity relating to teams, see the `teams` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
operationId: team-add
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team_add
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-team-add'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: team_add
supported-webhook-types:
- repository
- organization
- app
team-added-to-repository:
post:
summary: 'This event occurs when there is activity relating to teams in an organization.
For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A team was granted access to a repository.
operationId: team/added-to-repository
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-team-added-to-repository'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: team
supported-webhook-types:
- organization
- business
- app
team-created:
post:
summary: 'This event occurs when there is activity relating to teams in an organization.
For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A team was created.
operationId: team/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-team-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: team
supported-webhook-types:
- organization
- business
- app
team-deleted:
post:
summary: 'This event occurs when there is activity relating to teams in an organization.
For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A team was deleted.
operationId: team/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-team-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: team
supported-webhook-types:
- organization
- business
- app
team-edited:
post:
summary: 'This event occurs when there is activity relating to teams in an organization.
For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: The name, description, or visibility of a team was changed.
operationId: team/edited
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-team-edited'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: team
supported-webhook-types:
- organization
- business
- app
team-removed-from-repository:
post:
summary: 'This event occurs when there is activity relating to teams in an organization.
For more information, see "[About teams](https://docs.github.com/enterprise-server@3.9/organizations/organizing-members-into-teams/about-teams)."
To subscribe to this event, a GitHub App must have at least read-level access for the "Members" organization permission.'
description: A team's access to a repository was removed.
operationId: team/removed-from-repository
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#team
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-team-removed-from-repository'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: team
supported-webhook-types:
- organization
- business
- app
user-created:
post:
summary: This event occurs when there is activity relating to user accounts in an enterprise.
description: A user account was added to the enterprise.
operationId: user/created
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#user
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-user-created'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: true
category: webhooks
subcategory: user
supported-webhook-types:
- business
user-deleted:
post:
summary: This event occurs when there is activity relating to user accounts in an enterprise.
description: A user account was removed from the enterprise.
operationId: user/deleted
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#user
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-user-deleted'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: true
category: webhooks
subcategory: user
supported-webhook-types:
- business
watch-started:
post:
summary: 'This event occurs when there is activity relating to watching, or subscribing to, a repository. For more information about watching, see "[Managing your subscriptions](https://docs.github.com/enterprise-server@3.9/account-and-profile/managing-subscriptions-and-notifications-on-github/managing-subscriptions-for-activity-on-github/managing-your-subscriptions)." For information about the APIs to manage watching, see "[Watching](https://docs.github.com/enterprise-server@3.9/rest/activity/watching)" in the REST API documentation.
To subscribe to this event, a GitHub App must have at least read-level access for the "Metadata" repository permission.'
description: Someone started watching the repository.
operationId: watch/started
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#watch
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-watch-started'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: watch
supported-webhook-types:
- repository
- organization
- app
workflow-dispatch:
post:
summary: 'This event occurs when a GitHub Actions workflow is manually triggered. For more information, see "[Manually running a workflow](https://docs.github.com/enterprise-server@3.9/actions/managing-workflow-runs/manually-running-a-workflow)."
For activity relating to workflow runs, use the `workflow_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Contents" repository permission.'
operationId: workflow-dispatch
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_dispatch
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-dispatch'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_dispatch
supported-webhook-types:
- app
workflow-job-completed:
post:
summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A job in a workflow run finished. This event occurs when a job in a workflow is completed, regardless of whether the job was successful or unsuccessful.
operationId: workflow-job/completed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-job-completed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_job
supported-webhook-types:
- business
- repository
- organization
- app
workflow-job-in-progress:
post:
summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A job in a workflow run started processing on a runner.
operationId: workflow-job/in-progress
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-job-in-progress'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_job
supported-webhook-types:
- business
- repository
- organization
- app
workflow-job-queued:
post:
summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A job in a workflow run was created.
operationId: workflow-job/queued
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-job-queued'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_job
supported-webhook-types:
- business
- repository
- organization
- app
workflow-job-waiting:
post:
summary: 'This event occurs when there is activity relating to a job in a GitHub Actions workflow. For more information, see "[Using jobs in a workflow](https://docs.github.com/enterprise-server@3.9/actions/using-jobs/using-jobs-in-a-workflow)." For information about the API to manage workflow jobs, see "[Workflow jobs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-jobs)" in the REST API documentation.
For activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A job in a workflow run was created and is waiting for approvals.
operationId: workflow-job/waiting
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_job
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-job-waiting'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_job
supported-webhook-types:
- business
- repository
- organization
- app
workflow-run-completed:
post:
summary: 'This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)" in the REST API documentation.
For activity relating to a job in a workflow run, use the `workflow_job` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A workflow run finished. This event occurs when a workflow run is completed, regardless of whether the workflow was successful or unsuccessful.
operationId: workflow-run/completed
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-run-completed'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_run
supported-webhook-types:
- business
- repository
- organization
- app
workflow-run-in-progress:
post:
summary: 'This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)" in the REST API documentation.
For activity relating to a job in a workflow run, use the `workflow_job` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A workflow run started processing on a runner.
operationId: workflow-run/in-progress
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-run-in-progress'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_run
supported-webhook-types:
- business
- repository
- organization
- app
workflow-run-requested:
post:
summary: 'This event occurs when there is activity relating to a run of a GitHub Actions workflow. For more information, see "[About workflows](https://docs.github.com/enterprise-server@3.9/actions/using-workflows/about-workflows)." For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.9/graphql/reference/objects#workflowrun) or "[Workflow runs](https://docs.github.com/enterprise-server@3.9/rest/actions/workflow-runs)" in the REST API documentation.
For activity relating to a job in a workflow run, use the `workflow_job` event.
To subscribe to this event, a GitHub App must have at least read-level access for the "Actions" repository permission.'
description: A workflow run was triggered.
operationId: workflow-run/requested
externalDocs:
url: https://docs.github.com/enterprise-server@3.9/webhooks/webhook-events-and-payloads#workflow_run
parameters:
- name: User-Agent
in: header
example: GitHub-Hookshot/123abc
schema:
type: string
- name: X-Github-Hook-Id
in: header
example: 12312312
schema:
type: string
- name: X-Github-Event
in: header
example: issues
schema:
type: string
- name: X-Github-Hook-Installation-Target-Id
in: header
example: 123123
schema:
type: string
- name: X-Github-Hook-Installation-Target-Type
in: header
example: repository
schema:
type: string
- name: X-GitHub-Delivery
in: header
example: 0b989ba4-242f-11e5-81e1-c7b6966d2516
schema:
type: string
- name: X-Hub-Signature-256
in: header
example: sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e
schema:
type: string
- name: X-GitHub-Enterprise-Version
in: header
example: 3.1.9
schema:
type: string
- name: X-GitHub-Enterprise-Host
in: header
example: ghes.github.com
schema:
type: string
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/webhook-workflow-run-requested'
responses:
'200':
description: Return a 200 status to indicate that the data was received successfully
x-github:
githubCloudOnly: false
category: webhooks
subcategory: workflow_run
supported-webhook-types:
- business
- repository
- organization
- app