openapi: 3.0.3 info: version: 1.1.4 title: GitHub Application About Authenticated 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: Authenticated paths: /app: get: summary: GitHub Get the Authenticated App description: 'Returns the GitHub App associated with the authentication credentials used. To see how many app installations are associated with this GitHub App, see the `installations_count` in the response. For more details about your app''s installations, see the "[List installations for the authenticated app](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app)" endpoint. 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: - Authenticated operationId: getTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-the-authenticated-app parameters: [] responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/integration' examples: default: $ref: '#/components/examples/integration' x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /app/installation-requests: get: summary: GitHub List Installation Requests for the Authenticated App description: Lists all the pending installation requests for the authenticated GitHub App. tags: - Authenticated operationId: listInstallationRequestsForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installation-requests-for-the-authenticated-app parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: List of integration installation requests content: application/json: schema: type: array items: $ref: '#/components/schemas/integration-installation-request' examples: exampleKey1: $ref: '#/components/examples/integration-installation-request-paginated' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /app/installations: get: summary: GitHub List Installations for the Authenticated App description: 'The permissions the installation has are included under the `permissions` key. 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: - Authenticated operationId: listInstallationsForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#list-installations-for-the-authenticated-app parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/since' - name: outdated in: query required: false schema: type: string example: '2026-04-17T12:00:00Z' responses: '200': description: The permissions the installation has are included under the `permissions` key. content: application/json: schema: type: array items: $ref: '#/components/schemas/installation' examples: default: $ref: '#/components/examples/base-installation-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /app/installations/{installation_id}: get: summary: GitHub Get an Installation for the Authenticated App description: 'Enables an authenticated GitHub App to find an installation''s information using the installation id. 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: - Authenticated operationId: getAnInstallationForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-an-installation-for-the-authenticated-app parameters: - $ref: '#/components/parameters/installation-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/installation' examples: default: $ref: '#/components/examples/base-installation' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete an Installation for the Authenticated App description: 'Uninstalls a GitHub App on a user, organization, or business account. If you prefer to temporarily suspend an app''s access to your account''s resources, then we recommend the "[Suspend an app installation](https://docs.github.com/enterprise-server@3.9/rest/apps/apps#suspend-an-app-installation)" endpoint. 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: - Authenticated operationId: deleteAnInstallationForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#delete-an-installation-for-the-authenticated-app parameters: - $ref: '#/components/parameters/installation-id' responses: '204': description: Response '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{username}/events/orgs/{org}: get: summary: GitHub List Organization Events for the Authenticated User description: The GitHub Events API endpoint `/users/{username}/events/orgs/{org}` using the GET method retrieves a list of events for the authenticated user within a specific organization. This endpoint allows developers to access activity data related to a particular organization that the authenticated user is associated with, providing visibility into organization-level events and actions. The API returns event data in a paginated format, showing activities such as repository changes, issue updates, pull requests, and other collaborative actions performed within the specified organization context. Authentication is required to access this endpoint, and the results are filtered to show only events relevant to both the specified username and organization that the authenticated user has permission to view. tags: - Authenticated operationId: listOrganizationEventsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-organization-events-for-the-authenticated-user parameters: - $ref: '#/components/parameters/username' - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/event' examples: default: $ref: '#/components/examples/user-org-events-items' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: events security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /orgs/{org}/installation: get: summary: GitHub Get an Organization Installation for the Authenticated App description: 'Enables an authenticated GitHub App to find the organization''s installation information. 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: - Authenticated operationId: getAnOrganizationInstallationForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-an-organization-installation-for-the-authenticated-app parameters: - $ref: '#/components/parameters/org' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/installation' examples: default: $ref: '#/components/examples/installation' x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/installation: get: summary: GitHub Get Repository Installation for the Authenticated App description: 'Enables an authenticated GitHub App to find the repository''s installation information. The installation''s account type will be either an organization or a user account, depending which account the repository belongs to. 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: - Authenticated operationId: getrepositoryInstallationForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-a-repository-installation-for-the-authenticated-app parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/installation' examples: default: $ref: '#/components/examples/installation' '301': $ref: '#/components/responses/moved_permanently' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{username}/installation: get: summary: GitHub Get User Installation for the Authenticated App description: 'Enables an authenticated GitHub App to find the user’s installation information. 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: - Authenticated operationId: getuserInstallationForTheAuthenticatedApp externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/apps/apps#get-a-user-installation-for-the-authenticated-app parameters: - $ref: '#/components/parameters/username' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/installation' examples: default: $ref: '#/components/examples/installation' x-github: githubCloudOnly: false enabledForGitHubApps: false category: apps subcategory: apps security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /notifications/threads/{thread_id}/subscription: get: summary: GitHub Get Thread Subscription for the Authenticated User description: 'This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/enterprise-server@3.9/rest/activity/watching#get-a-repository-subscription). Note that subscriptions are only generated if a user is participating in a conversation--for example, they''ve replied to the thread, were **@mentioned**, or manually subscribe to a thread.' tags: - Authenticated operationId: getThreadSubscriptionForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#get-a-thread-subscription-for-the-authenticated-user parameters: - $ref: '#/components/parameters/thread-id' responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/thread-subscription' examples: default: $ref: '#/components/examples/thread-subscription' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /orgs/{org}/issues: get: summary: GitHub List Organization Issues Assigned to the Authenticated User description: 'List issues in an organization assigned to the authenticated user. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. 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: - Authenticated operationId: listOrganizationIssuesAssignedToTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-organization-issues-assigned-to-the-authenticated-user parameters: - $ref: '#/components/parameters/org' - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned example: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open example: open - $ref: '#/components/parameters/labels' - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created example: created - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue-with-repo-items' headers: Link: $ref: '#/components/headers/link' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /orgs/{org}/public_members/{username}: put: summary: GitHub Set Public Organization Membership for the Authenticated User description: 'The user can publicize their own membership. (A user cannot publicize the membership for another user.) Note that 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: - Authenticated operationId: setPublicOrganizationMembershipForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/orgs/members#set-public-organization-membership-for-the-authenticated-user parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/username' responses: '204': description: Response '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: orgs subcategory: members security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Remove Public Organization Membership for the Authenticated User description: Removes the public membership for the authenticated user from the specified organization, unless public visibility is enforced by default. tags: - Authenticated operationId: removePublicOrganizationMembershipForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/orgs/members#remove-public-organization-membership-for-the-authenticated-user parameters: - $ref: '#/components/parameters/org' - $ref: '#/components/parameters/username' responses: '204': description: Response x-github: githubCloudOnly: false enabledForGitHubApps: false category: orgs subcategory: members security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /repos/{owner}/{repo}/notifications: get: summary: GitHub List Repository Notifications for the Authenticated User description: Lists all notifications for the current user in the specified repository. tags: - Authenticated operationId: listRepositoryNotificationsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-repository-notifications-for-the-authenticated-user parameters: - $ref: '#/components/parameters/owner' - $ref: '#/components/parameters/repo' - $ref: '#/components/parameters/all' - $ref: '#/components/parameters/participating' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/before' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/thread' examples: default: $ref: '#/components/examples/thread-items' headers: Link: $ref: '#/components/headers/link' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: notifications security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/teams: get: summary: GitHub List Teams for the Authenticated User description: 'List all of the teams across all of the organizations to which the authenticated user belongs. OAuth app tokens and personal access tokens (classic) need the `user`, `repo`, or `read:org` scope to use this endpoint. When using a fine-grained personal access token, the resource owner of the token must be a single organization, and the response will only include the teams from that organization.' tags: - Authenticated operationId: listTeamsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/teams/teams#list-teams-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/team-full' examples: default: $ref: '#/components/examples/team-full-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: teams subcategory: teams security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user: get: summary: GitHub Get the Authenticated User description: OAuth app tokens and personal access tokens (classic) need the `user` scope in order for the response to include private profile information. tags: - Authenticated operationId: getTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/users#get-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 responses: '200': description: Response content: application/json: schema: oneOf: - $ref: '#/components/schemas/private-user' - $ref: '#/components/schemas/public-user' examples: response-with-public-and-private-profile-information: $ref: '#/components/examples/private-user-response-with-public-and-private-profile-information' response-with-public-profile-information: $ref: '#/components/examples/private-user-response-with-public-profile-information' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: users security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: - Authenticated 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/emails: get: summary: GitHub List Email Addresses for the Authenticated User description: 'Lists all of your email addresses, and specifies which one is visible to the public. OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.' tags: - Authenticated operationId: listEmailAddressesForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/emails#list-email-addresses-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/email' examples: default: $ref: '#/components/examples/email-items-2' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Add an Email Address for the Authenticated User description: OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - Authenticated operationId: addAnEmailAddressForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/emails#add-an-email-address-for-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: oneOf: - type: object properties: emails: description: Adds one or more email addresses to your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. type: array items: type: string example: username@example.com minItems: 1 example: [] required: - emails example: emails: - octocat@github.com - mona@github.com - type: array items: type: string example: username@example.com minItems: 1 - type: string examples: default: summary: Example adding multiple email addresses value: emails: - octocat@github.com - mona@github.com - octocat@octocat.org responses: '201': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/email' examples: default: $ref: '#/components/examples/email-items' '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: emails security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete an Email Address for the Authenticated User description: OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint. tags: - Authenticated operationId: deleteAnEmailAddressForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/emails#delete-an-email-address-for-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: content: application/json: schema: oneOf: - type: object description: Deletes one or more email addresses from your GitHub account. Must contain at least one email address. **Note:** Alternatively, you can pass a single email address or an `array` of emails addresses directly, but we recommend that you pass an object using the `emails` key. properties: emails: description: Email addresses associated with the GitHub user account. type: array items: type: string example: username@example.com minItems: 1 example: emails: - octocat@github.com - mona@github.com required: - emails - type: array items: type: string example: username@example.com minItems: 1 - type: string examples: default: summary: Example deleting multiple email accounts value: emails: - octocat@github.com - mona@github.com responses: '204': description: Response '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: emails security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/followers: get: summary: GitHub List Followers of the Authenticated User description: Lists the people following the authenticated user. tags: - Authenticated operationId: listFollowersOfTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/followers#list-followers-of-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/simple-user' examples: default: $ref: '#/components/examples/simple-user-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers x-api-evangelist-certified: '2025-07-18' x-api-naftiko-published: '2025-07-18' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/following: get: summary: GitHub List the People the Authenticated User Follows description: Lists the people who the authenticated user follows. tags: - Authenticated operationId: listThePeopleTheAuthenticatedUserFollows externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/followers#list-the-people-the-authenticated-user-follows parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/simple-user' examples: default: $ref: '#/components/examples/simple-user-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers x-api-evangelist-certified: '2025-07-18' x-api-naftiko-published: '2025-07-18' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/following/{username}: get: summary: GitHub Check if Person is Followed by the Authenticated User description: This GitHub API endpoint allows an authenticated user to verify whether they are currently following a specific GitHub user identified by the username parameter in the URL path. By sending a GET request to /user/following/{username}, the authenticated user can check their following status for the target user. The API returns a 204 No Content status if the authenticated user is following the specified username, or a 404 Not Found status if they are not following that user. This endpoint requires authentication and is useful for building features that display following relationships or allow users to manage their GitHub social connections programmatically. tags: - Authenticated operationId: checkIfPersonIsFollowedByTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/followers#check-if-a-person-is-followed-by-the-authenticated-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: '204': description: if the person is followed by the authenticated user '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': description: if the person is not followed by the authenticated user content: application/json: schema: $ref: '#/components/schemas/basic-error' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: followers security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/gpg_keys: get: summary: GitHub List Gpg Keys for the Authenticated User description: 'Lists the current user''s GPG keys. OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.' tags: - Authenticated operationId: listGpgKeysForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#list-gpg-keys-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/gpg-key' examples: default: $ref: '#/components/examples/gpg-key-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: gpg-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Create Gpg Key for the Authenticated User description: 'Adds a GPG key to the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.' operationId: createGpgKeyForTheAuthenticatedUser tags: - Authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#create-a-gpg-key-for-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: true content: application/json: schema: properties: name: description: A descriptive name for the new key. type: string armored_public_key: description: A GPG key in ASCII-armored format. type: string type: object required: - armored_public_key examples: default: value: name: Octocat's GPG Key armored_public_key: '--BEGIN PGP PUBLIC KEY BLOCK-- Version: GnuPG v1 mQINBFnZ2ZIBEADQ2Z7Z7 --END PGP PUBLIC KEY BLOCK--' responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/gpg-key' examples: default: $ref: '#/components/examples/gpg-key' '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: gpg-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/gpg_keys/{gpg_key_id}: get: summary: GitHub Get Gpg Key for the Authenticated User description: 'View extended details for a single GPG key. OAuth app tokens and personal access tokens (classic) need the `read:gpg_key` scope to use this endpoint.' tags: - Authenticated operationId: getGpgKeyForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#get-a-gpg-key-for-the-authenticated-user parameters: - $ref: '#/components/parameters/gpg-key-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/gpg-key' examples: default: $ref: '#/components/examples/gpg-key' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: gpg-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Gpg Key for the Authenticated User description: 'Removes a GPG key from the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `admin:gpg_key` scope to use this endpoint.' tags: - Authenticated operationId: deleteGpgKeyForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/gpg-keys#delete-a-gpg-key-for-the-authenticated-user parameters: - $ref: '#/components/parameters/gpg-key-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: '204': description: Response '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: gpg-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/issues: get: summary: GitHub List User Account Issues Assigned to the Authenticated User description: 'List issues across owned and member repositories assigned to the authenticated user. **Note**: GitHub''s REST API considers every pull request an issue, but not every issue is a pull request. For this reason, "Issues" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key. Be aware that the `id` of a pull request returned from "Issues" endpoints will be an _issue id_. To find out the pull request id, use the "[List pull requests](https://docs.github.com/enterprise-server@3.9/rest/pulls/pulls#list-pull-requests)" endpoint. 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: - Authenticated operationId: listUserAccountIssuesAssignedToTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/issues/issues#list-user-account-issues-assigned-to-the-authenticated-user parameters: - name: filter description: Indicates which sorts of issues to return. `assigned` means issues assigned to you. `created` means issues created by you. `mentioned` means issues mentioning you. `subscribed` means issues you're subscribed to updates for. `all` or `repos` means all issues you can see, regardless of participation or creation. in: query required: false schema: type: string enum: - assigned - created - mentioned - subscribed - repos - all default: assigned example: assigned - name: state description: Indicates the state of the issues to return. in: query required: false schema: type: string enum: - open - closed - all default: open example: open - $ref: '#/components/parameters/labels' - name: sort description: What to sort results by. in: query required: false schema: type: string enum: - created - updated - comments default: created example: created - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/since' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/issue' examples: default: $ref: '#/components/examples/issue-with-repo-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: issues subcategory: issues security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/keys: get: summary: GitHub List Public Ssh Keys for the Authenticated User description: 'Lists the public SSH keys for the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.' tags: - Authenticated operationId: listPublicSshKeysForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/keys#list-public-ssh-keys-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/key' examples: default: $ref: '#/components/examples/key-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Create Public Ssh Key for the Authenticated User description: 'Adds a public SSH key to the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `write:gpg_key` scope to use this endpoint.' operationId: createPublicSshKeyForTheAuthenticatedUser tags: - Authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/keys#create-a-public-ssh-key-for-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: true content: application/json: schema: properties: title: description: A descriptive name for the new key. type: string example: Personal MacBook Air key: description: The public SSH key to add to your GitHub account. type: string pattern: '^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) ' required: - key type: object examples: default: value: title: ssh-rsa AAAAB3NzaC1yc2EAAA key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/key' examples: default: $ref: '#/components/examples/key' '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: keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/keys/{key_id}: get: summary: GitHub Get Public Ssh Key for the Authenticated User description: 'View extended details for a single public SSH key. OAuth app tokens and personal access tokens (classic) need the `read:public_key` scope to use this endpoint.' tags: - Authenticated operationId: getPublicSshKeyForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/keys#get-a-public-ssh-key-for-the-authenticated-user parameters: - $ref: '#/components/parameters/key-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/key' examples: default: $ref: '#/components/examples/key' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Public Ssh Key for the Authenticated User description: 'Removes a public SSH key from the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `admin:public_key` scope to use this endpoint.' tags: - Authenticated operationId: deletePublicSshKeyForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/keys#delete-a-public-ssh-key-for-the-authenticated-user parameters: - $ref: '#/components/parameters/key-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: '204': description: Response '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/memberships/orgs: get: summary: GitHub List Organization Memberships for the Authenticated User description: Lists all of the authenticated user's organization memberships. tags: - Authenticated operationId: listOrganizationMembershipsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/orgs/members#list-organization-memberships-for-the-authenticated-user parameters: - name: state description: Indicates the state of the memberships to return. If not specified, the API returns both active and pending memberships. in: query required: false schema: type: string enum: - active - pending example: active - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/org-membership' examples: default: $ref: '#/components/examples/org-membership-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '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 /user/memberships/orgs/{org}: get: summary: GitHub Get an Organization Membership for the Authenticated User description: If the authenticated user is an active or pending member of the organization, this endpoint will return the user's membership. If the authenticated user is not affiliated with the organization, a `404` is returned. This endpoint will return a `403` if the request is made by a GitHub App that is blocked by the organization. tags: - Authenticated operationId: getAnOrganizationMembershipForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/orgs/members#get-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 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/org-membership' examples: default: $ref: '#/components/examples/org-membership' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: orgs subcategory: members security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK 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: - Authenticated 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 /user/orgs: get: summary: GitHub List Organizations for the Authenticated User description: 'List organizations for the authenticated user. For OAuth app tokens and personal access tokens (classic), this endpoint only lists organizations that your authorization allows you to operate on in some way (e.g., you can list teams with `read:org` scope, you can publicize your organization membership with `user` scope, etc.). Therefore, this API requires at least `user` or `read:org` scope for OAuth app tokens and personal access tokens (classic). Requests with insufficient scope will receive a `403 Forbidden` response.' tags: - Authenticated operationId: listOrganizationsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/orgs/orgs#list-organizations-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/organization-simple' examples: default: $ref: '#/components/examples/organization-simple-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: orgs subcategory: orgs security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/packages: get: summary: GitHub List Packages for the Authenticated User's Namespace description: 'Lists packages owned by the authenticated user within the user''s namespace. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."' tags: - Authenticated operationId: listPackagesForTheAuthenticatedUsersNamespace externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-packages-for-the-authenticated-users-namespace parameters: - name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. in: query required: true schema: type: string enum: - npm - maven - rubygems - docker - nuget - container example: npm - $ref: '#/components/parameters/package-visibility' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - 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: type: array items: $ref: '#/components/schemas/package' examples: default: $ref: '#/components/examples/packages-for-user' '400': $ref: '#/components/responses/package_es_list_error' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/packages/{package_type}/{package_name}: get: summary: GitHub Get Package for the Authenticated User description: 'Gets a specific package for a package owned by the authenticated user. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."' tags: - Authenticated operationId: getPackageForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-for-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-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 responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/package' examples: default: $ref: '#/components/examples/package-user' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Package for the Authenticated User description: 'Deletes a package owned by the authenticated user. You cannot delete a public package if any version of the package has more than 5,000 downloads. In this scenario, contact GitHub support for further assistance. OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, `repo` scope is also required. For the list these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."' tags: - Authenticated operationId: deletePackageForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-a-package-for-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-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 responses: '204': description: Response '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/packages/{package_type}/{package_name}/restore: post: summary: GitHub Restore Package for the Authenticated User description: "Restores a package owned by the authenticated user.\n\nYou can restore a deleted package under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"" tags: - Authenticated operationId: restorePackageForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-a-package-for-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-name' - name: token description: package token schema: type: string required: false in: query example: example_value - 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: '204': description: Response '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/packages/{package_type}/{package_name}/versions: get: summary: GitHub List Package Versions for Package Owned by the Authenticated User description: 'Lists package versions for a package owned by the authenticated user. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."' tags: - Authenticated operationId: listPackageVersionsForPackageOwnedByTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#list-package-versions-for-a-package-owned-by-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-name' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/per-page' - name: state in: query required: false description: The state of the package, either active or deleted. schema: type: string enum: - active - deleted default: active example: active - 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: type: array items: $ref: '#/components/schemas/package-version' examples: default: $ref: '#/components/examples/package-versions-for-authenticated-user' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/packages/{package_type}/{package_name}/versions/{package_version_id}: get: summary: GitHub Get Package Version for the Authenticated User description: 'Gets a specific package version for a package owned by the authenticated user. OAuth app tokens and personal access tokens (classic) need the `read:packages` scope to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."' tags: - Authenticated operationId: getPackageVersionForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#get-a-package-version-for-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-name' - $ref: '#/components/parameters/package-version-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/package-version' examples: default: $ref: '#/components/examples/package-version-authenticated-user' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Package Version for the Authenticated User description: 'Deletes a specific package version for a package owned by the authenticated user. If the package is public and the package version has more than 5,000 downloads, you cannot delete the package version. In this scenario, contact GitHub support for further assistance. The authenticated user must have admin permissions in the organization to use this endpoint. OAuth app tokens and personal access tokens (classic) need the `read:packages` and `delete:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages)."' tags: - Authenticated operationId: deletePackageVersionForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#delete-a-package-version-for-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-name' - $ref: '#/components/parameters/package-version-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: '204': description: Response '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/packages/{package_type}/{package_name}/versions/{package_version_id}/restore: post: summary: GitHub Restore Package Version for the Authenticated User description: "Restores a package version owned by the authenticated user.\n\nYou can restore a deleted package version under the following conditions:\n - The package was deleted within the last 30 days.\n - The same package namespace and version is still available and not reused for a new package. If the same package namespace is not available, you will not be able to restore your package. In this\nscenario, to restore the deleted package, you must delete the new package that uses the deleted package's namespace first.\nOAuth app tokens and personal access tokens (classic) need the `read:packages` and `write:packages` scopes to use this endpoint. If the `package_type` belongs to a GitHub Packages registry that only supports repository-scoped permissions, the `repo` scope is also required. For the list of these registries, see \"[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#permissions-for-repository-scoped-packages).\"" tags: - Authenticated operationId: restorePackageVersionForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/packages/packages#restore-a-package-version-for-the-authenticated-user parameters: - $ref: '#/components/parameters/package-type' - $ref: '#/components/parameters/package-name' - $ref: '#/components/parameters/package-version-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: '204': description: Response '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: packages subcategory: packages security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/public_emails: get: summary: GitHub List Public Email Addresses for the Authenticated User description: 'Lists your publicly visible email address, which you can set with the [Set primary email visibility for the authenticated user](https://docs.github.com/enterprise-server@3.9/rest/users/emails#set-primary-email-visibility-for-the-authenticated-user) endpoint. OAuth app tokens and personal access tokens (classic) need the `user:email` scope to use this endpoint.' tags: - Authenticated operationId: listPublicEmailAddressesForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/emails#list-public-email-addresses-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/email' examples: default: $ref: '#/components/examples/email-items-2' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: emails security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/repos: get: summary: GitHub List Repositories for the Authenticated User description: 'Lists repositories that the authenticated user has explicit permission (`:read`, `:write`, or `:admin`) to access. The authenticated user has explicit permission to access repositories they own, repositories where they are a collaborator, and repositories that they can access through an organization membership.' tags: - Authenticated operationId: listRepositoriesForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/repos/repos#list-repositories-for-the-authenticated-user parameters: - name: visibility description: Limit results to repositories with the specified visibility. in: query required: false schema: type: string enum: - all - public - private default: all example: all - name: affiliation description: "Comma-separated list of values. Can include: \n * `owner`: Repositories that are owned by the authenticated user. \n * `collaborator`: Repositories that the user has been added to as a collaborator. \n * `organization_member`: Repositories that the user has access to through being a member of an organization. This includes every repository on every team that the user is on." in: query required: false schema: type: string default: owner,collaborator,organization_member example: example_value - name: type description: Limit results to repositories of the specified type. Will cause a `422` error if used in the same request as **visibility** or **affiliation**. in: query required: false schema: type: string enum: - all - owner - public - private - member default: all example: all - name: sort description: The property to sort the results by. in: query required: false schema: type: string enum: - created - updated - pushed - full_name default: full_name example: created - name: direction description: 'The order to sort by. Default: `asc` when using `full_name`, otherwise `desc`.' in: query required: false schema: type: string enum: - asc - desc example: asc - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/since-repo-date' - $ref: '#/components/parameters/before-repo-date' - 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: type: array items: $ref: '#/components/schemas/repository' examples: default: $ref: '#/components/examples/repository-items-default-response' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '422': $ref: '#/components/responses/validation_failed' x-github: githubCloudOnly: false enabledForGitHubApps: false category: repos subcategory: repos security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Create Repository for the Authenticated User description: 'Creates a new repository for the authenticated user. OAuth app tokens and personal access tokens (classic) need the `public_repo` or `repo` scope to create a public repository, and `repo` scope to create a private repository.' tags: - Authenticated operationId: createRepositoryForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/repos/repos#create-a-repository-for-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: true content: application/json: schema: properties: name: description: The name of the repository. type: string example: Team Environment description: description: A short description of the repository. type: string homepage: description: A URL with more information about the repository. type: string private: description: Whether the repository is private. default: false type: boolean 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_discussions: description: Whether discussions are enabled. default: false type: boolean example: true team_id: description: The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization. type: integer auto_init: description: Whether the repository is initialized with a minimal README. default: false type: boolean gitignore_template: description: The desired language or platform to apply to the .gitignore. example: Haskell type: string license_template: description: The license keyword of the open source license for this repository. example: mit type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_rebase_merge: description: Whether to allow rebase 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 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.' has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true is_template: description: Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true required: - name type: object examples: default: value: name: Hello-World description: This is your first repo! homepage: https://github.com private: false is_template: true responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/full-repository' examples: default: $ref: '#/components/examples/full-repository' headers: Location: example: https://api.github.com/repos/octocat/Hello-World schema: type: string '304': $ref: '#/components/responses/not_modified' '400': $ref: '#/components/responses/bad_request' '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: repos subcategory: repos security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/repository_invitations: get: summary: GitHub List Repository Invitations for the Authenticated User description: When authenticating as a user, this endpoint will list all currently open repository invitations for that user. tags: - Authenticated operationId: listRepositoryInvitationsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/collaborators/invitations#list-repository-invitations-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/repository-invitation' examples: default: $ref: '#/components/examples/repository-invitation-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: collaborators subcategory: invitations security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/social_accounts: get: summary: GitHub List Social Accounts for the Authenticated User description: The GitHub User API endpoint `/user/social_accounts` with the GET method retrieves a list of all social media accounts associated with the authenticated user's GitHub profile. This endpoint requires authentication and returns information about connected social accounts such as LinkedIn, Twitter, Facebook, or other platforms that the user has linked to their GitHub account. The response typically includes details like the provider name, the profile URL, and any other relevant metadata for each connected social account. This allows applications to access and display the authenticated user's social media presence and cross-platform identity information programmatically. tags: - Authenticated operationId: listSocialAccountsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#list-social-accounts-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/social-account' examples: default: $ref: '#/components/examples/social-account-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: social-accounts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Add Social Accounts for the Authenticated User description: 'Add one or more social accounts to the authenticated user''s profile. OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.' tags: - Authenticated operationId: addSocialAccountsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#add-social-accounts-for-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: true content: application/json: schema: type: object properties: account_urls: description: Full URLs for the social media profiles to add. type: array items: type: string example: https://twitter.com/github example: [] required: - account_urls example: account_urls: - https://www.linkedin.com/company/github/ - https://twitter.com/github examples: default: summary: Adding multiple social accounts value: account_urls: - https://facebook.com/GitHub - https://www.youtube.com/@GitHub responses: '201': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/social-account' examples: default: $ref: '#/components/examples/social-account-items' '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: true category: users subcategory: social-accounts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete Social Accounts for the Authenticated User description: 'Deletes one or more social accounts from the authenticated user''s profile. OAuth app tokens and personal access tokens (classic) need the `user` scope to use this endpoint.' tags: - Authenticated operationId: deleteSocialAccountsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/social-accounts#delete-social-accounts-for-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: true content: application/json: schema: type: object properties: account_urls: description: Full URLs for the social media profiles to delete. type: array items: type: string example: https://twitter.com/github example: [] required: - account_urls example: account_urls: - https://www.linkedin.com/company/github/ - https://twitter.com/github examples: default: summary: Deleting multiple social accounts value: account_urls: - https://facebook.com/GitHub - https://www.youtube.com/@GitHub responses: '204': description: Response '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: true category: users subcategory: social-accounts security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/ssh_signing_keys: get: summary: GitHub List Ssh Signing Keys for the Authenticated User description: 'Lists the SSH signing keys for the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.' tags: - Authenticated operationId: listSshSigningKeysForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#list-ssh-signing-keys-for-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/ssh-signing-key' examples: default: $ref: '#/components/examples/ssh-signing-key-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false previews: [] category: users subcategory: ssh-signing-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK post: summary: GitHub Create Ssh Signing Key for the Authenticated User description: 'Creates an SSH signing key for the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `write:ssh_signing_key` scope to use this endpoint.' operationId: createSshSigningKeyForTheAuthenticatedUser tags: - Authenticated externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#create-a-ssh-signing-key-for-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: true content: application/json: schema: properties: title: description: A descriptive name for the new key. type: string example: Personal MacBook Air key: description: The public SSH key to add to your GitHub account. For more information, see "[Checking for existing SSH keys](https://docs.github.com/enterprise-server@3.9/authentication/connecting-to-github-with-ssh/checking-for-existing-ssh-keys)." type: string pattern: '^ssh-(rsa|dss|ed25519) |^ecdsa-sha2-nistp(256|384|521) |^(sk-ssh-ed25519|sk-ecdsa-sha2-nistp256)@openssh.com ' required: - key type: object examples: default: value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 title: ssh-rsa AAAAB3NzaC1yc2EAAA responses: '201': description: Response content: application/json: schema: $ref: '#/components/schemas/ssh-signing-key' examples: default: $ref: '#/components/examples/ssh-signing-key' '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: ssh-signing-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/ssh_signing_keys/{ssh_signing_key_id}: get: summary: GitHub Get an Ssh Signing Key for the Authenticated User description: 'Gets extended details for an SSH signing key. OAuth app tokens and personal access tokens (classic) need the `read:ssh_signing_key` scope to use this endpoint.' tags: - Authenticated operationId: getAnSshSigningKeyForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#get-an-ssh-signing-key-for-the-authenticated-user parameters: - $ref: '#/components/parameters/ssh-signing-key-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/ssh-signing-key' examples: default: $ref: '#/components/examples/ssh-signing-key' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: ssh-signing-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Delete an Ssh Signing Key for the Authenticated User description: 'Deletes an SSH signing key from the authenticated user''s GitHub account. OAuth app tokens and personal access tokens (classic) need the `admin:ssh_signing_key` scope to use this endpoint.' tags: - Authenticated operationId: deleteAnSshSigningKeyForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/users/ssh-signing-keys#delete-an-ssh-signing-key-for-the-authenticated-user parameters: - $ref: '#/components/parameters/ssh-signing-key-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: '204': description: Response '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: users subcategory: ssh-signing-keys security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/starred: get: summary: GitHub List Repositories Starred by the Authenticated User description: 'Lists repositories the authenticated user has starred. 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.star+json`**: Includes a timestamp of when the star was created.' tags: - Authenticated operationId: listRepositoriesStarredByTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/starring#list-repositories-starred-by-the-authenticated-user parameters: - $ref: '#/components/parameters/sort-starred' - $ref: '#/components/parameters/direction' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/repository' examples: default-response: $ref: '#/components/examples/repository-items-default-response' application/vnd.github.v3.star+json: schema: type: array items: $ref: '#/components/schemas/starred-repository' examples: alternative-response-with-star-creation-timestamps: $ref: '#/components/examples/starred-repository-items-alternative-response-with-star-creation-timestamps' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/starred/{owner}/{repo}: get: summary: GitHub Check if Repository is Starred by the Authenticated User description: This API endpoint allows you to verify whether the currently authenticated user has starred a specific GitHub repository. By making a GET request to /user/starred/{owner}/{repo}, where {owner} is the repository owner's username and {repo} is the repository name, the API will return a 204 No Content status if the repository is starred by the user, or a 404 Not Found status if it is not starred. This endpoint requires authentication and is useful for applications that need to display or track a user's starred repositories, customize user interfaces based on starring status, or implement features that depend on whether a user has previously shown interest in a particular repository. tags: - Authenticated operationId: checkIfRepositoryIsStarredByTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/starring#check-if-a-repository-is-starred-by-the-authenticated-user 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 responses: '204': description: Response if this repository is starred by you '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': description: Not Found if this repository is not starred by you content: application/json: schema: $ref: '#/components/schemas/basic-error' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK put: summary: GitHub Star Repository for the Authenticated User description: This API operation allows an authenticated GitHub user to star a specified repository by making a PUT request to the /user/starred/{owner}/{repo} endpoint. When executed, it adds the repository identified by the owner's username and repository name to the authenticated user's list of starred repositories, indicating interest or bookmarking the project for future reference. The operation requires authentication and proper authorization to modify the user's starred repositories list, and returns a success status when the repository is successfully starred or an appropriate error response if the operation fails due to invalid parameters or insufficient permissions. tags: - Authenticated operationId: starRepositoryForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/starring#star-a-repository-for-the-authenticated-user 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 responses: '204': description: Response '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK delete: summary: GitHub Unstar Repository for the Authenticated User description: This API operation allows an authenticated user to remove a star from a specified repository on GitHub. By sending a DELETE request to the endpoint with the repository owner's username and repository name as path parameters, the user can unstar a previously starred repository, effectively removing it from their list of starred repositories. This action requires proper authentication and only affects the authenticated user's star status for the specified repository. tags: - Authenticated operationId: unstarRepositoryForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/starring#unstar-a-repository-for-the-authenticated-user 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 responses: '204': description: Response '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: starring security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /user/subscriptions: get: summary: GitHub List Repositories Watched by the Authenticated User description: The GitHub User API's GET /user/subscriptions endpoint retrieves a list of repositories that the authenticated user is currently watching. This operation requires authentication and returns repository data for all subscriptions associated with the authenticated user's account, allowing applications to programmatically access and manage a user's watched repositories. The endpoint provides information about repositories the user has chosen to receive notifications from, enabling features like activity tracking and repository management in third-party applications. tags: - Authenticated operationId: listRepositoriesWatchedByTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/watching#list-repositories-watched-by-the-authenticated-user parameters: - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/minimal-repository_2' examples: default: $ref: '#/components/examples/minimal-repository-items' headers: Link: $ref: '#/components/headers/link' '304': $ref: '#/components/responses/not_modified' '401': $ref: '#/components/responses/requires_authentication' '403': $ref: '#/components/responses/forbidden' x-github: githubCloudOnly: false enabledForGitHubApps: false category: activity subcategory: watching security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{username}/events: get: summary: GitHub List Events for the Authenticated User description: The GitHub User API endpoint `/users/{username}/events` with the GET method retrieves a chronological list of public events performed by a specified user. This operation allows you to fetch up to 300 public events from the past 90 days associated with the given username, including actions such as pushing commits, creating repositories, opening issues, submitting pull requests, and other activities visible on their public profile. The response returns an array of event objects containing details like event type, repository information, timestamps, and payload data specific to each action, making it useful for tracking user activity, building activity feeds, or analyzing contribution patterns across GitHub. tags: - Authenticated operationId: listEventsForTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-events-for-the-authenticated-user parameters: - $ref: '#/components/parameters/username' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/event' examples: default: $ref: '#/components/examples/user-events-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events x-api-evangelist-certified: '2025-07-18' x-api-naftiko-published: '2025-07-18' security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /users/{username}/received_events: get: summary: GitHub List Events Received by the Authenticated User description: These are events that you've received by watching repositories and following users. If you are authenticated as the given user, you will see private events. Otherwise, you'll only see public events. tags: - Authenticated operationId: listEventsReceivedByTheAuthenticatedUser externalDocs: description: API method documentation url: https://docs.github.com/enterprise-server@3.9/rest/activity/events#list-events-received-by-the-authenticated-user parameters: - $ref: '#/components/parameters/username' - $ref: '#/components/parameters/per-page' - $ref: '#/components/parameters/page' - 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: type: array items: $ref: '#/components/schemas/event' examples: default: $ref: '#/components/examples/user-received-events-items' x-github: githubCloudOnly: false enabledForGitHubApps: true category: activity subcategory: events 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' 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 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 enterprise: title: Enterprise description: An enterprise on GitHub. type: object properties: description: description: A short description of the enterprise. type: string nullable: true example: This is an example repository html_url: type: string format: uri example: https://github.com/enterprises/octo-business website_url: description: The enterprise's website URL. type: string nullable: true format: uri example: https://api.github.com/repos/octocat/Hello-World id: description: Unique identifier of the enterprise example: 42 type: integer node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the enterprise. type: string example: Octo Business slug: description: The slug url identifier for the enterprise. type: string example: octo-business created_at: type: string nullable: true format: date-time example: '2019-01-26T19:01:12Z' updated_at: type: string nullable: true format: date-time example: '2019-01-26T19:14:43Z' avatar_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World required: - id - node_id - name - slug - html_url - created_at - updated_at - avatar_url 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 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 nullable: true 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 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' 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! 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: 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 nullable: true 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' organization: $ref: '#/components/schemas/nullable-simple-user' parent: $ref: '#/components/schemas/repository' source: $ref: '#/components/schemas/repository' 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_2' 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 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 actor: title: Actor description: Actor type: object properties: id: type: integer example: 42 login: type: string example: octocat display_login: type: string example: octocat gravatar_id: type: string nullable: true example: '12345678' url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World avatar_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World required: - id - login - gravatar_id - url - avatar_url package-version: title: Package Version description: A version of a software package type: object properties: id: description: Unique identifier of the package version. type: integer example: 1 name: description: The name of the package version. type: string example: latest url: type: string example: https://api.github.com/orgs/github/packages/container/super-linter/versions/786068 package_html_url: type: string example: https://github.com/orgs/github/packages/container/package/super-linter html_url: type: string example: https://github.com/orgs/github/packages/container/super-linter/786068 license: type: string example: MIT description: type: string example: This is an example repository 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' deleted_at: type: string format: date-time example: '2014-03-03T18:58:10Z' metadata: type: object title: Package Version Metadata properties: package_type: type: string example: docker enum: - npm - maven - rubygems - docker - nuget - container container: type: object title: Container Metadata properties: tags: type: array items: type: string required: - tags docker: type: object title: Docker Metadata properties: tag: type: array items: type: string required: - tags required: - package_type required: - id - name - url - package_html_url - created_at - updated_at 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 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 nullable-minimal-repository: title: Minimal Repository description: Minimal Repository type: object properties: id: type: integer 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' 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! 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 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 nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string nullable: true language: type: string nullable: true 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' 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 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_2' license: type: object properties: key: type: string name: type: string spdx_id: type: string url: type: string node_id: type: string nullable: true 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_2' 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 nullable: true 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 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 event: title: Event description: Event type: object properties: id: type: string example: '12345678' type: type: string nullable: true example: User actor: $ref: '#/components/schemas/actor' repo: type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - name - url org: $ref: '#/components/schemas/actor' payload: type: object properties: action: type: string issue: $ref: '#/components/schemas/issue' comment: $ref: '#/components/schemas/issue-comment' pages: type: array items: type: object properties: page_name: type: string title: type: string summary: type: string nullable: true action: type: string sha: type: string html_url: type: string public: type: boolean example: true created_at: type: string format: date-time nullable: true example: '2026-04-17T12:00:00Z' required: - id - type - actor - repo - payload - public - created_at 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 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 thread-subscription: title: Thread Subscription description: Thread Subscription type: object properties: subscribed: type: boolean example: true ignored: type: boolean example: true reason: type: string nullable: true example: example_value created_at: type: string format: date-time example: '2012-10-06T21:34:12Z' nullable: true url: type: string format: uri example: https://api.github.com/notifications/threads/1/subscription thread_url: type: string format: uri example: https://api.github.com/notifications/threads/1 repository_url: type: string format: uri example: https://api.github.com/repos/1 required: - created_at - ignored - reason - url - subscribed ssh-signing-key: title: SSH Signing Key description: A public SSH key used to sign Git commits type: object properties: key: type: string example: example_value id: type: integer example: 42 title: type: string example: Example Title created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' required: - key - id - title - created_at 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 scim-error: 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 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 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' 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! 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 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 nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string homepage: type: string nullable: true language: type: string nullable: true 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' 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 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_2' license: type: object properties: key: type: string name: type: string spdx_id: type: string url: type: string node_id: type: string nullable: true 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_2' 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_2' 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 starred-repository: title: Starred Repository description: Starred Repository type: object properties: starred_at: type: string format: date-time example: '2026-04-17T12:00:00Z' repo: $ref: '#/components/schemas/repository' required: - starred_at - repo package: title: Package description: A software package type: object properties: id: description: Unique identifier of the package. type: integer example: 1 name: description: The name of the package. type: string example: super-linter package_type: type: string example: docker enum: - npm - maven - rubygems - docker - nuget - container url: type: string example: https://api.github.com/orgs/github/packages/container/super-linter html_url: type: string example: https://github.com/orgs/github/packages/container/package/super-linter version_count: description: The number of versions of the package. type: integer example: 1 visibility: type: string example: private enum: - private - public owner: $ref: '#/components/schemas/nullable-simple-user' repository: $ref: '#/components/schemas/nullable-minimal-repository' 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 - package_type - visibility - url - html_url - version_count - created_at - updated_at integration-installation-request: title: Integration Installation Request description: Request to install an integration on a target type: object properties: id: description: Unique identifier of the request installation. type: integer example: 42 node_id: type: string example: MDExOkludGVncmF0aW9uMQ== account: anyOf: - $ref: '#/components/schemas/simple-user' - $ref: '#/components/schemas/enterprise' example: example_value requester: $ref: '#/components/schemas/simple-user' created_at: type: string format: date-time example: '2022-07-08T16:18:44-04:00' required: - id - account - requester - created_at nullable-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 nullable: true 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 repository: $ref: '#/components/schemas/minimal-repository_2' invitee: $ref: '#/components/schemas/nullable-simple-user' inviter: $ref: '#/components/schemas/nullable-simple-user' 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-of-conduct_2: 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 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 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\nclarified by project maintainers.\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 nullable: true example: https://api.github.com/repos/octocat/Hello-World required: - url - html_url - key - name 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 gpg-key: title: GPG Key description: A unique encryption key type: object properties: id: type: integer example: 3 name: type: string example: Octocat's GPG Key nullable: true primary_key_id: type: integer nullable: true example: 42 key_id: type: string example: 3262EFF25BA0D270 public_key: type: string example: xsBNBFayYZ... emails: type: array example: - email: octocat@users.noreply.github.com verified: true items: type: object properties: email: type: string verified: type: boolean subkeys: type: array example: - id: 4 primary_key_id: 3 key_id: 4A595D4C72EE49C7 public_key: zsBNBFayYZ... emails: [] can_sign: false can_encrypt_comms: true can_encrypt_storage: true can_certify: false created_at: '2016-03-24T11:31:04-06:00' expires_at: null revoked: false items: type: object properties: id: type: integer primary_key_id: type: integer key_id: type: string public_key: type: string emails: type: array items: type: object properties: email: type: string verified: type: boolean subkeys: type: array items: {} can_sign: type: boolean can_encrypt_comms: type: boolean can_encrypt_storage: type: boolean can_certify: type: boolean created_at: type: string expires_at: type: string nullable: true raw_key: type: string nullable: true revoked: type: boolean can_sign: type: boolean example: true can_encrypt_comms: type: boolean example: true can_encrypt_storage: type: boolean example: true can_certify: type: boolean example: true created_at: type: string format: date-time example: '2016-03-24T11:31:04-06:00' expires_at: type: string format: date-time nullable: true example: '2026-04-17T12:00:00Z' revoked: type: boolean example: true raw_key: type: string nullable: true example: example_value required: - id - primary_key_id - key_id - raw_key - public_key - created_at - expires_at - can_sign - can_encrypt_comms - can_encrypt_storage - can_certify - emails - subkeys - revoked 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 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 email: title: Email description: Email type: object properties: email: type: string format: email example: octocat@github.com primary: type: boolean example: true verified: type: boolean example: true visibility: type: string example: public nullable: true required: - email - primary - verified - visibility security-and-analysis_2: nullable: true 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 installation: title: Installation description: Installation type: object properties: id: description: The ID of the installation. type: integer example: 1 account: nullable: true anyOf: - $ref: '#/components/schemas/simple-user' - $ref: '#/components/schemas/enterprise' example: example_value repository_selection: description: Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected example: all access_tokens_url: type: string format: uri example: https://api.github.com/app/installations/1/access_tokens repositories_url: type: string format: uri example: https://api.github.com/installation/repositories html_url: type: string format: uri example: https://github.com/organizations/github/settings/installations/1 app_id: type: integer example: 1 target_id: description: The ID of the user or organization this token is being scoped to. type: integer example: 42 target_type: type: string example: Organization permissions: $ref: '#/components/schemas/app-permissions' events: type: array items: type: string 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' 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 app_slug: type: string example: github-actions suspended_by: $ref: '#/components/schemas/nullable-simple-user' suspended_at: type: string format: date-time nullable: true example: '2026-04-17T12:00:00Z' contact_email: type: string example: '"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com"' nullable: true required: - id - app_id - app_slug - target_id - target_type - single_file_name - repository_selection - access_tokens_url - html_url - repositories_url - events - account - permissions - created_at - updated_at - suspended_by - suspended_at 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 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 thread: title: Thread description: Thread type: object properties: id: type: string example: '12345678' repository: $ref: '#/components/schemas/minimal-repository' subject: type: object properties: title: type: string url: type: string latest_comment_url: type: string type: type: string required: - title - url - latest_comment_url - type reason: type: string example: example_value unread: type: boolean example: true updated_at: type: string example: '2026-04-17T12:00:00Z' last_read_at: type: string example: '2026-04-17T12:00:00Z' url: type: string example: https://api.github.com/repos/octocat/Hello-World subscription_url: type: string example: https://api.github.com/notifications/threads/2/subscription required: - id - unread - reason - updated_at - last_read_at - subject - repository - url - subscription_url 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-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 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 social-account: title: Social account description: Social media account type: object properties: provider: type: string example: linkedin url: type: string example: https://www.linkedin.com/company/github/ required: - provider - url 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 key: title: Key description: Key type: object properties: key: type: string example: example_value id: type: integer example: 42 url: type: string example: https://api.github.com/repos/octocat/Hello-World title: type: string example: Example Title created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' verified: type: boolean example: true read_only: type: boolean example: true required: - key - id - url - title - created_at - verified - read_only examples: ssh-signing-key-items: value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 url: https://api.github.com/user/keys/2 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 id: 3 url: https://api.github.com/user/keys/3 title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' starred-repository-items-alternative-response-with-star-creation-timestamps: summary: Alternative response with star creation timestamps value: - starred_at: '2011-01-16T19:06:43Z' 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: null 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 template_repository: null 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://github.com/licenses/mit forks: 1 open_issues: 1 watchers: 1 email-items-2: value: - email: octocat@github.com verified: true primary: true visibility: public key: value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 url: https://api.github.com/user/keys/2 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' verified: false read_only: false social-account-items: value: - provider: twitter url: https://twitter.com/github package-versions-for-authenticated-user: value: - id: 45763 name: sha256:08a44bab0bddaddd8837a8b381aebc2e4b933768b981685a9e088360af0d3dd9 url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/45763 package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker created_at: '2020-09-11T21:56:40Z' updated_at: '2021-02-05T21:32:32Z' html_url: https://github.com/users/octocat/packages/container/hello_docker/45763 metadata: package_type: container container: tags: - latest - id: 881 name: sha256:b3d3e366b55f9a54599220198b3db5da8f53592acbbb7dc7e4e9878762fc5344 url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/881 package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker created_at: '2020-05-21T22:22:20Z' updated_at: '2021-02-05T21:32:32Z' html_url: https://github.com/users/octocat/packages/container/hello_docker/881 metadata: package_type: container container: tags: [] packages-for-user: value: - id: 197 name: hello_docker package_type: container owner: login: octocat id: 9919 node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= avatar_url: https://avatars.octocatusercontent.com/u/9919?v=4 gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/github followers_url: https://api.github.com/users/github/followers following_url: https://api.github.com/users/github/following{/other_user} gists_url: https://api.github.com/users/github/gists{/gist_id} starred_url: https://api.github.com/users/github/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/github/subscriptions organizations_url: https://api.github.com/users/github/orgs repos_url: https://api.github.com/users/github/repos events_url: https://api.github.com/users/github/events{/privacy} received_events_url: https://api.github.com/users/github/received_events type: User site_admin: false version_count: 1 visibility: private url: https://api.github.com/orgs/github/packages/container/hello_docker created_at: '2020-05-19T22:19:11Z' updated_at: '2020-05-19T22:19:11Z' html_url: https://github.com/orgs/github/packages/container/package/hello_docker - id: 198 name: goodbye_docker package_type: container owner: login: github id: 9919 node_id: MDEyOk9yZ2FuaXphdGlvbjk5MTk= avatar_url: https://avatars.githubusercontent.com/u/9919?v=4 gravatar_id: '' url: https://api.github.com/users/octocat html_url: https://github.com/github followers_url: https://api.github.com/users/github/followers following_url: https://api.github.com/users/github/following{/other_user} gists_url: https://api.github.com/users/github/gists{/gist_id} starred_url: https://api.github.com/users/github/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/github/subscriptions organizations_url: https://api.github.com/users/github/orgs repos_url: https://api.github.com/users/github/repos events_url: https://api.github.com/users/github/events{/privacy} received_events_url: https://api.github.com/users/github/received_events type: User site_admin: false version_count: 2 visibility: private url: https://api.github.com/user/octocat/packages/container/goodbye_docker created_at: '2020-05-20T22:19:11Z' updated_at: '2020-05-20T22:19:11Z' html_url: https://github.com/user/octocat/packages/container/package/goodbye_docker user-org-events-items: value: - id: '22249084964' type: PushEvent actor: id: 583231 login: octocat display_login: octocat gravatar_id: '' url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: push_id: 10115855396 size: 1 distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd commits: - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 author: email: octocat@github.com name: Monalisa Octocat message: commit distinct: true url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: false created_at: '2022-06-09T12:47:28Z' - id: '22196946742' type: CreateEvent actor: id: 583231 login: octocat display_login: octocat gravatar_id: '' url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: ref: null ref_type: repository master_branch: master description: null pusher_type: user public: false created_at: '2022-06-07T07:50:26Z' org: id: 9919 login: github gravatar_id: '' url: https://api.github.com/orgs/github avatar_url: https://avatars.githubusercontent.com/u/9919? installation: value: id: 1 account: login: github id: 1 node_id: MDEyOk9yZ2FuaXphdGlvbjE= avatar_url: https://github.com/images/error/hubot_happy.gif gravatar_id: '' url: https://api.github.com/orgs/github html_url: https://github.com/github followers_url: https://api.github.com/users/github/followers following_url: https://api.github.com/users/github/following{/other_user} gists_url: https://api.github.com/users/github/gists{/gist_id} starred_url: https://api.github.com/users/github/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/github/subscriptions organizations_url: https://api.github.com/users/github/orgs repos_url: https://api.github.com/orgs/github/repos events_url: https://api.github.com/orgs/github/events received_events_url: https://api.github.com/users/github/received_events type: Organization site_admin: false repository_selection: all access_tokens_url: https://api.github.com/app/installations/1/access_tokens repositories_url: https://api.github.com/installation/repositories html_url: https://github.com/organizations/github/settings/installations/1 app_id: 1 target_id: 1 target_type: Organization permissions: checks: write metadata: read contents: read events: - push - pull_request created_at: '2018-02-09T20:51:14Z' updated_at: '2018-02-09T20:51:14Z' single_file_name: config.yml has_multiple_single_files: true single_file_paths: - config.yml - .github/issue_TEMPLATE.md app_slug: github-actions suspended_at: null suspended_by: null private-user-response-with-public-profile-information: summary: Response with public profile information 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' base-installation-items: value: - id: 1 account: 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 access_tokens_url: https://api.github.com/app/installations/1/access_tokens repositories_url: https://api.github.com/installation/repositories html_url: https://github.com/organizations/github/settings/installations/1 app_id: 1 target_id: 1 target_type: Organization permissions: checks: write metadata: read contents: read events: - push - pull_request single_file_name: config.yaml has_multiple_single_files: true single_file_paths: - config.yml - .github/issue_TEMPLATE.md repository_selection: selected created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' app_slug: github-actions suspended_at: null suspended_by: null user-events-items: value: - id: '22249084947' type: WatchEvent actor: id: 583231 login: octocat display_login: octocat gravatar_id: '' url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: action: started public: true created_at: '2022-06-09T12:47:28Z' - id: '22249084964' type: PushEvent actor: id: 583231 login: octocat display_login: octocat gravatar_id: '' url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: push_id: 10115855396 size: 1 distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd commits: - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 author: email: octocat@github.com name: Monalisa Octocat message: commit distinct: true url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: false created_at: '2022-06-07T07:50:26Z' org-membership: value: url: https://api.github.com/orgs/invitocat/memberships/defunkt state: pending role: admin organization_url: https://api.github.com/orgs/invitocat 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 repository-invitation-items: value: - id: 1 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' url: https://api.github.com/user/repository_invitations/1296269 html_url: https://github.com/octocat/Hello-World/invitations node_id: MDQ6VXNlcjE= integration: value: id: 1 slug: octoapp node_id: MDExOkludGVncmF0aW9uMQ== 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 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 repository-items-default-response: summary: Default response 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 language: null 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 template_repository: null 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://github.com/licenses/mit forks: 1 open_issues: 1 watchers: 1 key-items: value: - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 url: https://api.github.com/user/keys/2 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' verified: false read_only: false - key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJy931234 id: 3 url: https://api.github.com/user/keys/3 title: ssh-rsa AAAAB3NzaC1yc2EAAB created_at: '2020-07-11T21:31:57Z' verified: false read_only: false thread-items: value: - id: '1' 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 subject: title: Greetings url: https://api.github.com/repos/octokit/octokit.rb/issues/123 latest_comment_url: https://api.github.com/repos/octokit/octokit.rb/issues/comments/123 type: Issue reason: subscribed unread: true updated_at: '2014-11-07T22:01:45Z' last_read_at: '2014-11-07T22:01:45Z' url: https://api.github.com/notifications/threads/1 subscription_url: https://api.github.com/notifications/threads/1/subscription user-received-events-items: value: - id: '22249084964' type: PushEvent actor: id: 583231 login: octocat display_login: octocat gravatar_id: '' url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: push_id: 10115855396 size: 1 distinct_size: 1 ref: refs/heads/master head: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 before: 883efe034920928c47fe18598c01249d1a9fdabd commits: - sha: 7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 author: email: octocat@github.com name: Monalisa Octocat message: commit distinct: true url: https://api.github.com/repos/octocat/Hello-World/commits/7a8f3ac80e2ad2f6842cb86f576d4bfe2c03e300 public: true created_at: '2022-06-09T12:47:28Z' - id: '22196946742' type: CreateEvent actor: id: 583231 login: octocat display_login: octocat gravatar_id: '' url: https://api.github.com/users/octocat avatar_url: https://avatars.githubusercontent.com/u/583231?v=4 repo: id: 1296269 name: octocat/Hello-World url: https://api.github.com/repos/octocat/Hello-World payload: ref: null ref_type: repository master_branch: master description: null pusher_type: user public: false created_at: '2022-06-07T07:50:26Z' org: id: 9919 login: github gravatar_id: '' url: https://api.github.com/orgs/github avatar_url: https://avatars.githubusercontent.com/u/9919? thread-subscription: value: subscribed: true ignored: false reason: null created_at: '2012-10-06T21:34:12Z' url: https://api.github.com/notifications/threads/1/subscription thread_url: https://api.github.com/notifications/threads/1 simple-user-items: 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 issue-with-repo-items: 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' 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: null 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 template_repository: null 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://github.com/licenses/mit forks: 1 open_issues: 1 watchers: 1 author_association: COLLABORATOR org-membership-items: 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 - url: https://api.github.com/orgs/invitocat/memberships/defunkt state: pending role: admin organization_url: https://api.github.com/orgs/invitocat 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 organization-simple-items: 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 ssh-signing-key: value: key: 2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234 id: 2 url: https://api.github.com/user/keys/2 title: ssh-rsa AAAAB3NzaC1yc2EAAA created_at: '2020-06-11T21:31:57Z' base-installation: value: id: 1 account: 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 access_tokens_url: https://api.github.com/app/installations/1/access_tokens repositories_url: https://api.github.com/installation/repositories html_url: https://github.com/organizations/github/settings/installations/1 app_id: 1 target_id: 1 target_type: Organization permissions: checks: write metadata: read contents: read events: - push - pull_request single_file_name: config.yaml has_multiple_single_files: true single_file_paths: - config.yml - .github/issue_TEMPLATE.md repository_selection: selected created_at: '2017-07-08T16:18:44-04:00' updated_at: '2017-07-08T16:18:44-04:00' app_slug: github-actions suspended_at: null suspended_by: null 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: null 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 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: null 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: null 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: null 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 gpg-key: value: id: 3 name: Octocat's GPG Key primary_key_id: 2 key_id: 3262EFF25BA0D270 public_key: xsBNBFayYZ... emails: - email: octocat@users.noreply.github.com verified: true subkeys: - id: 4 primary_key_id: 3 key_id: 4A595D4C72EE49C7 public_key: zsBNBFayYZ... emails: [] can_sign: false can_encrypt_comms: true can_encrypt_storage: true can_certify: false created_at: '2016-03-24T11:31:04-06:00' expires_at: '2016-03-24T11:31:04-07:00' revoked: false can_sign: true can_encrypt_comms: false can_encrypt_storage: false can_certify: true created_at: '2016-03-24T11:31:04-06:00' expires_at: '2016-03-24T11:31:04-07:00' revoked: false raw_key: '"--BEGIN PGP PUBLIC KEY BLOCK--\nVersion: GnuPG v2\n\nmQENBFayYZ0BCAC4hScoJXXpyR+MXGcrBxElqw3FzCVvkViuyeko+Jp76QJhg8kr\nucRTxbnOoHfda/FmilEa/wxf9ch5/PSrrL26FxEoPHhJolp8fnIDLQeITn94NYdB\nZtnnEKslpPrG97qSUWIchvyqCPtvOb8+8fWvGx9K/ZWcEEdh1X8+WFR2jMENMeoX\nwxHWQoPnS7LpX/85/M7VUcJxvDVfv+eHsnQupmE5bGarKNih0oMe3LbdN3qA5PTz\nSCm6Iudar1VsQ+xTz08ymL7t4pnEtLguQ7EyatFHCjxNblv5RzxoL0tDgN3HqoDz\nc7TEA+q4RtDQl9amcvQ95emnXmZ974u7UkYdABEBAAG0HlNvbWUgVXNlciA8c29t\nZXVzZXJAZ21haWwuY29tPokBOAQTAQIAIgUCVrJhnQIbAwYLCQgHAwIGFQgCCQoL\nBBYCAwECHgECF4AACgkQMmLv8lug0nAViQgArWjI55+7p48URr2z9Jvak+yrBTx1\nzkufltQAnHTJkq+Kl9dySSmTnOop8o3rE4++IOpYV5Y36PkKf9EZMk4n1RQiDPKE\nAFtRVTkRaoWzOir9KQXJPfhKrl01j/QzY+utfiMvUoBJZ9ybq8Pa885SljW9lbaX\nIYw+hl8ZdJ2KStvGrEyfQvRyq3aN5c9TV//4BdGnwx7Qabq/U+G18lizG6f/yq15\ned7t0KELaCfeKPvytp4VE9/z/Ksah/h3+Qilx07/oG2Ae5kC1bEC9coD/ogPUhbv\nb2bsBIoY9E9YwsLoif2lU+o1t76zLgUktuNscRRUKobW028H1zuFS/XQhrkBDQRW\nsmGdAQgApnyyv3i144OLYy0O4UKQxd3e10Y3WpDwfnGIBefAI1m7RxnUxBag/DsU\n7gi9qLEC4VHSfq4eiNfr1LJOyCL2edTgCWFgBhVjbXjZe6YAOrAnhxwCErnN0Y7N\n6s8wVh9fObSOyf8ZE6G7JeKpcq9Q6gd/KxagfD48a1v+fyRHpyQc6J9pUEmtrDJ7\nBjmsd2VWzLBvNWdHyxDNtZweIaqIO9VUYYpr1mtTliNBOZLUelmgrt7HBRcJpWMA\nS8muVVbuP5MK0trLBq/JB8qUH3zRzB/PhMgzmkIfjEK1VYDWm4E8DYyTWEJcHqkb\neqFsNjrIlwPaA122BWC6gUOPwwH+oQARAQABiQEfBBgBAgAJBQJWsmGdAhsMAAoJ\nEDJi7/JboNJwAyAIALd4xcdmGbZD98gScJzqwzkOMcO8zFHqHNvJ42xIFvGny7c0\n1Rx7iyrdypOby5AxE+viQcjG4rpLZW/xKYBNGrCfDyQO7511I0v8x20EICMlMfD/\nNrWQCzesEPcUlKTP07d+sFyP8AyseOidbzY/92CpskTgdSBjY/ntLSaoknl/fjJE\nQM8OkPqU7IraO1Jzzdnm20d5PZL9+PIwIWdSTedU/vBMTJyNcoqvSfKf1wNC66XP\nhqfYgXJE564AdWZKA3C0IyCqiv+LHwxLnUHio1a4/r91C8KPzxs6tGxRDjXLd7ms\nuYFGWymiUGOE/giHlcxdYcHzwLnPDliMQOLiTkK5AQ0EVuxMygEIAOD+bW1cDTmE\nBxh5JECoqeHuwgl6DlLhnubWPkQ4ZeRzBRAsFcEJQlwlJjrzFDicL+lnm6Qq4tt0\n560TwHdf15/AKTZIZu7H25axvGNzgeaUkJEJdYAq9zTKWwX7wKyzBszi485nQg97\nMfAqwhMpDW0Qqf8+7Ug+WEmfBSGv9uL3aQC6WEeIsHfri0n0n8v4XgwhfShXguxO\nCsOztEsuW7WWKW9P4TngKKv4lCHdPlV6FwxeMzODBJvc2fkHVHnqc0PqszJ5xcF8\n6gZCpMM027SbpeYWCAD5zwJyYP9ntfO1p2HjnQ1dZaP9FeNcO7uIV1Lnd1eGCu6I\nsrVp5k1f3isAEQEAAYkCPgQYAQIACQUCVuxMygIbAgEpCRAyYu/yW6DScMBdIAQZ\nAQIABgUCVuxMygAKCRCKohN4dhq2b4tcCACHxmOHVXNpu47OvUGYQydLgMACUlXN\nlj+HfE0VReqShxdDmpasAY9IRpuMB2RsGK8GbNP+4SlOlAiPf5SMhS7nZNkNDgQQ\naZ3HFpgrFmFwmE10BKT4iQtoxELLM57z0qGOAfTsEjWFQa4sF+6IHAQR/ptkdkkI\nBUEXiMnAwVwBysLIJiLO8qdjB6qp52QkT074JVrwywT/P+DkMfC2k4r/AfEbf6eF\ndmPDuPk6KD87+hJZsSa5MaMUBQVvRO/mgEkhJRITVu58eWGaBOcQJ8gqurhCqM5P\nDfUA4TJ7wiqM6sS764vV1rOioTTXkszzhClQqET7hPVnVQjenYgv0EZHNyQH/1f1\n/CYqvV1vFjM9vJjMbxXsATCkZe6wvBVKD8vLsJAr8N+onKQz+4OPc3kmKq7aESu3\nCi/iuie5KKVwnuNhr9AzT61vEkKxwHcVFEvHB77F6ZAAInhRvjzmQbD2dlPLLQCC\nqDj71ODSSAPTEmUy6969bgD9PfWei7kNkBIx7s3eBv8yzytSc2EcuUgopqFazquw\nFs1+tqGHjBvQfTo6bqbJjp/9Ci2pvde3ElV2rAgUlb3lqXyXjRDqrXosh5GcRPQj\nK8Nhj1BNhnrCVskE4BP0LYbOHuzgm86uXwGCFsY+w2VOsSm16Jx5GHyG5S5WU3+D\nIts/HFYRLiFgDLmTlxo=\n=+OzK\n--END PGP PUBLIC KEY BLOCK--"' 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 email-items: value: - email: octocat@octocat.org primary: false verified: false visibility: public - email: octocat@github.com primary: false verified: false visibility: null - email: mona@github.com primary: false verified: false visibility: null gpg-key-items: value: - id: 3 name: Octocat's GPG Key primary_key_id: 2 key_id: 3262EFF25BA0D270 public_key: xsBNBFayYZ... emails: - email: octocat@users.noreply.github.com verified: true subkeys: - id: 4 primary_key_id: 3 key_id: 4A595D4C72EE49C7 public_key: zsBNBFayYZ... emails: [] can_sign: false can_encrypt_comms: true can_encrypt_storage: true can_certify: false created_at: '2016-03-24T11:31:04-06:00' expires_at: '2016-03-24T11:31:04-07:00' revoked: false can_sign: true can_encrypt_comms: false can_encrypt_storage: false can_certify: true created_at: '2016-03-24T11:31:04-06:00' expires_at: '2016-03-24T11:31:04-07:00' revoked: false raw_key: string minimal-repository-items: 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 language: null 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 has_discussions: false 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 security_and_analysis: advanced_security: status: enabled secret_scanning: status: enabled secret_scanning_push_protection: status: disabled 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 package-user: value: id: 40201 name: octo-name package_type: rubygems owner: login: octocat id: 209477 node_id: MDQ6VXNlcjIwOTQ3Nw== avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 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: true version_count: 3 visibility: public url: https://api.github.com/users/octocat/packages/rubygems/octo-name created_at: '2019-10-20T14:17:14Z' updated_at: '2019-10-20T14:17:14Z' repository: id: 216219492 node_id: MDEwOlJlcG9zaXRvcnkyMTYyMTk0OTI= name: octo-name-repo full_name: octocat/octo-name-repo private: false owner: login: octocat id: 209477 node_id: MDQ6VXNlcjIwOTQ3Nw== avatar_url: https://avatars.githubusercontent.com/u/209477?v=4 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: true html_url: https://github.com/octocat/octo-name-repo description: Project for octocats fork: false url: https://api.github.com/repos/octocat/octo-name-repo forks_url: https://api.github.com/repos/octocat/octo-name-repo/forks keys_url: https://api.github.com/repos/octocat/octo-name-repo/keys{/key_id} collaborators_url: https://api.github.com/repos/octocat/octo-name-repo/collaborators{/collaborator} teams_url: https://api.github.com/repos/octocat/octo-name-repo/teams hooks_url: https://api.github.com/repos/octocat/octo-name-repo/hooks issue_events_url: https://api.github.com/repos/octocat/octo-name-repo/issues/events{/number} events_url: https://api.github.com/repos/octocat/octo-name-repo/events assignees_url: https://api.github.com/repos/octocat/octo-name-repo/assignees{/user} branches_url: https://api.github.com/repos/octocat/octo-name-repo/branches{/branch} tags_url: https://api.github.com/repos/octocat/octo-name-repo/tags blobs_url: https://api.github.com/repos/octocat/octo-name-repo/git/blobs{/sha} git_tags_url: https://api.github.com/repos/octocat/octo-name-repo/git/tags{/sha} git_refs_url: https://api.github.com/repos/octocat/octo-name-repo/git/refs{/sha} trees_url: https://api.github.com/repos/octocat/octo-name-repo/git/trees{/sha} statuses_url: https://api.github.com/repos/octocat/octo-name-repo/statuses/{sha} languages_url: https://api.github.com/repos/octocat/octo-name-repo/languages stargazers_url: https://api.github.com/repos/octocat/octo-name-repo/stargazers contributors_url: https://api.github.com/repos/octocat/octo-name-repo/contributors subscribers_url: https://api.github.com/repos/octocat/octo-name-repo/subscribers subscription_url: https://api.github.com/repos/octocat/octo-name-repo/subscription commits_url: https://api.github.com/repos/octocat/octo-name-repo/commits{/sha} git_commits_url: https://api.github.com/repos/octocat/octo-name-repo/git/commits{/sha} comments_url: https://api.github.com/repos/octocat/octo-name-repo/comments{/number} issue_comment_url: https://api.github.com/repos/octocat/octo-name-repo/issues/comments{/number} contents_url: https://api.github.com/repos/octocat/octo-name-repo/contents/{+path} compare_url: https://api.github.com/repos/octocat/octo-name-repo/compare/{base}...{head} merges_url: https://api.github.com/repos/octocat/octo-name-repo/merges archive_url: https://api.github.com/repos/octocat/octo-name-repo/{archive_format}{/ref} downloads_url: https://api.github.com/repos/octocat/octo-name-repo/downloads issues_url: https://api.github.com/repos/octocat/octo-name-repo/issues{/number} pulls_url: https://api.github.com/repos/octocat/octo-name-repo/pulls{/number} milestones_url: https://api.github.com/repos/octocat/octo-name-repo/milestones{/number} notifications_url: https://api.github.com/repos/octocat/octo-name-repo/notifications{?since,all,participating} labels_url: https://api.github.com/repos/octocat/octo-name-repo/labels{/name} releases_url: https://api.github.com/repos/octocat/octo-name-repo/releases{/id} deployments_url: https://api.github.com/repos/octocat/octo-name-repo/deployments html_url: https://github.com/octocat/octo-name-repo/packages/40201 integration-installation-request-paginated: value: - id: 25381 node_id: MDEyOkludGVncmF0aW9uMTIzNDU2Nzg5MA== account: login: octo-org id: 6811672 node_id: MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI= avatar_url: https://avatars3.githubusercontent.com/u/6811672?v=4 gravatar_id: '' url: https://api.github.com/users/octo-org html_url: https://github.com/octo-org followers_url: https://api.github.com/users/octo-org/followers following_url: https://api.github.com/users/octo-org/following{/other_user} gists_url: https://api.github.com/users/octo-org/gists{/gist_id} starred_url: https://api.github.com/users/octo-org/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/octo-org/subscriptions organizations_url: https://api.github.com/users/octo-org/orgs repos_url: https://api.github.com/users/octo-org/repos events_url: https://api.github.com/users/octo-org/events{/privacy} received_events_url: https://api.github.com/users/octo-org/received_events type: Organization site_admin: false requester: 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: '2022-07-08T16:18:44-04:00' package-version-authenticated-user: value: id: 214 name: sha256:3561f0cff06caccddb99c93bd26e712fcc56a811de0f8ea7a17bb865f30b176a url: https://api.github.com/users/octocat/packages/container/hello_docker/versions/214 package_html_url: https://github.com/users/octocat/packages/container/package/hello_docker created_at: '2020-05-15T03:46:45Z' updated_at: '2020-05-15T03:46:45Z' html_url: https://github.com/users/octocat/packages/container/hello_docker/214 metadata: package_type: container container: tags: - 1.13.6 team-full-items: 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 parent: null 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 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' updated_at: '2017-08-17T12:37:15Z' type: Organization private-user-response-with-public-and-private-profile-information: summary: Response with public and private profile information 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 responses: forbidden: description: Forbidden content: application/json: schema: $ref: '#/components/schemas/basic-error' requires_authentication: description: Requires authentication content: application/json: schema: $ref: '#/components/schemas/basic-error' bad_request: description: Bad Request content: application/json: schema: $ref: '#/components/schemas/basic-error' application/scim+json: schema: $ref: '#/components/schemas/scim-error' package_es_list_error: description: The value of `per_page` multiplied by `page` cannot be greater than 10000. moved_permanently: description: Moved permanently content: application/json: schema: $ref: '#/components/schemas/basic-error' not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error' 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' parameters: username: name: username description: The handle for the GitHub user account. in: path required: true schema: type: string all: name: all description: If `true`, show notifications marked as read. in: query required: false schema: type: boolean default: false participating: name: participating description: If `true`, only shows notifications in which the user is directly participating or mentioned. in: query required: false schema: type: boolean default: false key-id: name: key_id description: The unique identifier of the key. 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 package-type: name: package_type description: The type of supported package. Packages in GitHub's Gradle registry have the type `maven`. Docker images pushed to GitHub's Container registry (`ghcr.io`) have the type `container`. You can use the type `docker` to find images that were pushed to GitHub's Docker registry (`docker.pkg.github.com`), even if these have now been migrated to the Container registry. in: path required: true schema: type: string enum: - npm - maven - rubygems - docker - nuget - container per-page: name: per_page description: The number of results per page (max 100). For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 30 before-repo-date: name: before description: 'Only show repositories updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false schema: type: string format: date-time since-repo-date: name: since description: 'Only show repositories updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false schema: type: string format: date-time package-visibility: name: visibility description: 'The selected visibility of the packages. This parameter is optional and only filters an existing result set. The `internal` visibility is only supported for GitHub Packages registries that allow for granular permissions. For other ecosystems `internal` is synonymous with `private`. For the list of GitHub Packages registries that support granular permissions, see "[About permissions for GitHub Packages](https://docs.github.com/enterprise-server@3.9/packages/learn-github-packages/about-permissions-for-github-packages#granular-permissions-for-userorganization-scoped-packages)."' in: query required: false schema: type: string enum: - public - private - internal before: name: before description: 'Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false schema: type: string format: date-time ssh-signing-key-id: name: ssh_signing_key_id description: The unique identifier of the SSH signing key. in: path required: true schema: type: integer thread-id: name: thread_id description: The unique identifier of the notification thread. This corresponds to the value returned in the `id` field when you retrieve notifications (for example with the [`GET /notifications` operation](https://docs.github.com/enterprise-server@3.9/rest/activity/notifications#list-notifications-for-the-authenticated-user)). in: path required: true schema: type: integer gpg-key-id: name: gpg_key_id description: The unique identifier of the GPG key. in: path required: true schema: type: integer package-version-id: name: package_version_id description: Unique identifier of the package version. 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 installation-id: name: installation_id description: The unique identifier of the installation. in: path required: true schema: type: integer examples: default: value: 1 owner: name: owner description: The account owner of the repository. The name is not case sensitive. in: path required: true schema: type: string direction: name: direction description: The direction to sort the results by. in: query required: false schema: type: string enum: - asc - desc default: desc since: name: since description: 'Only show results that were last updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.' in: query required: false schema: type: string format: date-time sort-starred: name: sort description: The property to sort the results by. `created` means when the repository was starred. `updated` means when the repository was last pushed to. in: query required: false schema: type: string enum: - created - updated default: created page: name: page description: The page number of the results to fetch. For more information, see "[Using pagination in the REST API](https://docs.github.com/enterprise-server@3.9/rest/using-the-rest-api/using-pagination-in-the-rest-api)." in: query schema: type: integer default: 1 labels: name: labels description: 'A list of comma separated label names. Example: `bug,ui,@high`' in: query required: false schema: type: string package-name: name: package_name description: The name of the package. in: path required: true schema: type: string headers: link: example: ; rel="next", ; rel="last" schema: type: string 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