openapi: 3.0.3 info: version: 1.1.4 title: GitHub Code of Conduct API description: Use the REST API to get information about codes of conduct. 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 tags: - name: All - name: Code - name: Conduct - name: Get 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 externalDocs: description: GitHub Enterprise Developer Docs url: https://docs.github.com/enterprise-server@3.9/rest/ paths: /codes_of_conduct: get: summary: GitHub Get All Codes of Conduct description: >- The GitHub Code of Conduct API endpoint `/codes_of_conduct` with the GET method retrieves all available codes of conduct that can be applied to repositories on GitHub. This operation returns a list of codes of conduct templates that organizations and repository owners can use to establish community guidelines and behavioral expectations for their projects. Each code of conduct in the response typically includes metadata such as a unique key identifier, name, and URL where the full text can be accessed, allowing developers to programmatically discover and reference GitHub's standardized codes of conduct for implementation in their repositories. tags: - All - Conduct - Get operationId: getAllCodesOfConduct externalDocs: description: API method documentation url: >- https://docs.github.com/enterprise-server@3.9/rest/codes-of-conduct/codes-of-conduct#get-all-codes-of-conduct parameters: [] responses: '200': description: Response content: application/json: schema: type: array items: $ref: '#/components/schemas/code-of-conduct' examples: default: $ref: '#/components/examples/code-of-conduct-simple-items' '304': $ref: '#/components/responses/not_modified' x-github: githubCloudOnly: false enabledForGitHubApps: true category: codes-of-conduct subcategory: codes-of-conduct security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK /codes_of_conduct/{key}: get: summary: GitHub Get Code of Conduct description: >- The GitHub Code of Conduct API endpoint `/codes_of_conduct/{key}` using the GET method retrieves detailed information about a specific code of conduct available on GitHub. By providing a unique key identifier in the path parameter, this operation returns comprehensive details about the selected code of conduct, including its name, full text content, URL, and other relevant metadata. This endpoint is useful for developers who want to programmatically access and display code of conduct information for their repositories, helping them understand the specific guidelines and behavioral expectations associated with a particular conduct policy that GitHub supports and makes available to the community. tags: - Code - Conduct - Get operationId: getCodeOfConduct externalDocs: description: API method documentation url: >- https://docs.github.com/enterprise-server@3.9/rest/codes-of-conduct/codes-of-conduct#get-a-code-of-conduct parameters: - name: key in: path required: true schema: type: string example: example_value responses: '200': description: Response content: application/json: schema: $ref: '#/components/schemas/code-of-conduct' examples: default: $ref: '#/components/examples/code-of-conduct' '304': $ref: '#/components/responses/not_modified' '404': $ref: '#/components/responses/not_found' x-github: githubCloudOnly: false enabledForGitHubApps: true category: codes-of-conduct subcategory: codes-of-conduct security: - bearerHttpAuthentication: [] x-microcks-operation: delay: 0 dispatcher: FALLBACK 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 components: schemas: 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 ## Our Pledge In 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. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project 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. ## Scope This 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, 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. ## Enforcement Instances 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. Project 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. ## Attribution This 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/). html_url: type: string format: uri nullable: true example: https://api.github.com/repos/octocat/Hello-World required: - url - html_url - key - name webhook-branch-protection-rule-created: title: branch protection rule created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' rule: title: branch protection rule description: >- The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. type: object properties: admin_enforced: type: boolean allow_deletions_enforcement_level: type: string enum: - 'off' - non_admins - everyone allow_force_pushes_enforcement_level: type: string enum: - 'off' - non_admins - everyone authorized_actor_names: type: array items: type: string authorized_actors_only: type: boolean authorized_dismissal_actors_only: type: boolean create_protected: type: boolean created_at: type: string format: date-time dismiss_stale_reviews_on_push: type: boolean id: type: integer ignore_approvals_from_contributors: type: boolean linear_history_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone merge_queue_enforcement_level: type: string enum: - 'off' - non_admins - everyone name: type: string pull_request_reviews_enforcement_level: type: string enum: - 'off' - non_admins - everyone repository_id: type: integer require_code_owner_review: type: boolean required_approving_review_count: type: integer required_conversation_resolution_level: type: string enum: - 'off' - non_admins - everyone required_deployments_enforcement_level: type: string enum: - 'off' - non_admins - everyone required_status_checks: type: array items: type: string required_status_checks_enforcement_level: type: string enum: - 'off' - non_admins - everyone signature_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone strict_required_status_checks_policy: type: boolean updated_at: type: string format: date-time required: - id - repository_id - name - created_at - updated_at - pull_request_reviews_enforcement_level - required_approving_review_count - dismiss_stale_reviews_on_push - require_code_owner_review - authorized_dismissal_actors_only - ignore_approvals_from_contributors - required_status_checks - required_status_checks_enforcement_level - strict_required_status_checks_policy - signature_requirement_enforcement_level - linear_history_requirement_enforcement_level - admin_enforced - allow_force_pushes_enforcement_level - allow_deletions_enforcement_level - merge_queue_enforcement_level - required_deployments_enforcement_level - required_conversation_resolution_level - authorized_actors_only - authorized_actor_names sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - rule - repository - sender webhook-branch-protection-rule-deleted: title: branch protection rule deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' rule: title: branch protection rule description: >- The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. type: object properties: admin_enforced: type: boolean allow_deletions_enforcement_level: type: string enum: - 'off' - non_admins - everyone allow_force_pushes_enforcement_level: type: string enum: - 'off' - non_admins - everyone authorized_actor_names: type: array items: type: string authorized_actors_only: type: boolean authorized_dismissal_actors_only: type: boolean create_protected: type: boolean created_at: type: string format: date-time dismiss_stale_reviews_on_push: type: boolean id: type: integer ignore_approvals_from_contributors: type: boolean linear_history_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone merge_queue_enforcement_level: type: string enum: - 'off' - non_admins - everyone name: type: string pull_request_reviews_enforcement_level: type: string enum: - 'off' - non_admins - everyone repository_id: type: integer require_code_owner_review: type: boolean required_approving_review_count: type: integer required_conversation_resolution_level: type: string enum: - 'off' - non_admins - everyone required_deployments_enforcement_level: type: string enum: - 'off' - non_admins - everyone required_status_checks: type: array items: type: string required_status_checks_enforcement_level: type: string enum: - 'off' - non_admins - everyone signature_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone strict_required_status_checks_policy: type: boolean updated_at: type: string format: date-time required: - id - repository_id - name - created_at - updated_at - pull_request_reviews_enforcement_level - required_approving_review_count - dismiss_stale_reviews_on_push - require_code_owner_review - authorized_dismissal_actors_only - ignore_approvals_from_contributors - required_status_checks - required_status_checks_enforcement_level - strict_required_status_checks_policy - signature_requirement_enforcement_level - linear_history_requirement_enforcement_level - admin_enforced - allow_force_pushes_enforcement_level - allow_deletions_enforcement_level - merge_queue_enforcement_level - required_deployments_enforcement_level - required_conversation_resolution_level - authorized_actors_only - authorized_actor_names sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - rule - repository - sender webhook-branch-protection-rule-edited: title: branch protection rule edited event type: object properties: action: type: string enum: - edited example: edited changes: description: If the action was `edited`, the changes to the rule. type: object properties: admin_enforced: type: object properties: from: type: boolean nullable: true required: - from authorized_actor_names: type: object properties: from: type: array items: type: string required: - from authorized_actors_only: type: object properties: from: type: boolean nullable: true required: - from authorized_dismissal_actors_only: type: object properties: from: type: boolean nullable: true required: - from linear_history_requirement_enforcement_level: type: object properties: from: type: string enum: - 'off' - non_admins - everyone required: - from required_status_checks: type: object properties: from: type: array items: type: string required: - from required_status_checks_enforcement_level: type: object properties: from: type: string enum: - 'off' - non_admins - everyone required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' rule: title: branch protection rule description: >- The branch protection rule. Includes a `name` and all the [branch protection settings](https://docs.github.com/enterprise-server@3.9/github/administering-a-repository/defining-the-mergeability-of-pull-requests/about-protected-branches#about-branch-protection-settings) applied to branches that match the name. Binary settings are boolean. Multi-level configurations are one of `off`, `non_admins`, or `everyone`. Actor and build lists are arrays of strings. type: object properties: admin_enforced: type: boolean allow_deletions_enforcement_level: type: string enum: - 'off' - non_admins - everyone allow_force_pushes_enforcement_level: type: string enum: - 'off' - non_admins - everyone authorized_actor_names: type: array items: type: string authorized_actors_only: type: boolean authorized_dismissal_actors_only: type: boolean create_protected: type: boolean created_at: type: string format: date-time dismiss_stale_reviews_on_push: type: boolean id: type: integer ignore_approvals_from_contributors: type: boolean linear_history_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone merge_queue_enforcement_level: type: string enum: - 'off' - non_admins - everyone name: type: string pull_request_reviews_enforcement_level: type: string enum: - 'off' - non_admins - everyone repository_id: type: integer require_code_owner_review: type: boolean required_approving_review_count: type: integer required_conversation_resolution_level: type: string enum: - 'off' - non_admins - everyone required_deployments_enforcement_level: type: string enum: - 'off' - non_admins - everyone required_status_checks: type: array items: type: string required_status_checks_enforcement_level: type: string enum: - 'off' - non_admins - everyone signature_requirement_enforcement_level: type: string enum: - 'off' - non_admins - everyone strict_required_status_checks_policy: type: boolean updated_at: type: string format: date-time required: - id - repository_id - name - created_at - updated_at - pull_request_reviews_enforcement_level - required_approving_review_count - dismiss_stale_reviews_on_push - require_code_owner_review - authorized_dismissal_actors_only - ignore_approvals_from_contributors - required_status_checks - required_status_checks_enforcement_level - strict_required_status_checks_policy - signature_requirement_enforcement_level - linear_history_requirement_enforcement_level - admin_enforced - allow_force_pushes_enforcement_level - allow_deletions_enforcement_level - merge_queue_enforcement_level - required_deployments_enforcement_level - required_conversation_resolution_level - authorized_actors_only - authorized_actor_names sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - rule - repository - sender webhook-cache-sync: type: object properties: after: type: string example: example_value before: type: string example: example_value cache_location: type: string example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - cache_location - ref - before - after webhook-check-run-completed: title: Check Run Completed Event type: object properties: action: type: string enum: - completed example: completed check_run: $ref: '#/components/schemas/check-run-with-simple-check-suite' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - check_run - repository - sender webhook-check-run-completed-form-encoded: title: Check Run Completed Event description: The check_run.completed webhook encoded with URL encoding type: object properties: payload: description: >- A URL-encoded string of the check_run.completed JSON payload. The decoded payload is a JSON object. type: string example: example_value required: - payload webhook-check-run-created: title: Check Run Created Event type: object properties: action: type: string enum: - created example: created check_run: $ref: '#/components/schemas/check-run-with-simple-check-suite' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - check_run - repository - sender webhook-check-run-created-form-encoded: title: Check Run Created Event description: The check_run.created webhook encoded with URL encoding type: object properties: payload: description: >- A URL-encoded string of the check_run.created JSON payload. The decoded payload is a JSON object. type: string example: example_value required: - payload webhook-check-run-requested-action: title: Check Run Requested Action Event type: object properties: action: type: string enum: - requested_action example: requested_action check_run: $ref: '#/components/schemas/check-run-with-simple-check-suite' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' requested_action: description: The action requested by the user. type: object properties: identifier: description: The integrator reference of the action requested by the user. type: string sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - check_run - repository - sender webhook-check-run-requested-action-form-encoded: title: Check Run Requested Action Event description: The check_run.requested_action webhook encoded with URL encoding type: object properties: payload: description: >- A URL-encoded string of the check_run.requested_action JSON payload. The decoded payload is a JSON object. type: string example: example_value required: - payload webhook-check-run-rerequested: title: Check Run Re-Requested Event type: object properties: action: type: string enum: - rerequested example: rerequested check_run: $ref: '#/components/schemas/check-run-with-simple-check-suite' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - check_run - repository - sender webhook-check-run-rerequested-form-encoded: title: Check Run Re-Requested Event description: The check_run.rerequested webhook encoded with URL encoding type: object properties: payload: description: >- A URL-encoded string of the check_run.rerequested JSON payload. The decoded payload is a JSON object. type: string example: example_value required: - payload webhook-check-suite-completed: title: check_suite completed event type: object properties: action: type: string enum: - completed example: completed check_suite: description: >- The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite). type: object properties: after: type: string nullable: true app: title: 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: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - merge_group - pull_request_review_thread - workflow_job - merge_queue_entry - security_and_analysis - projects_v2_item - secret_scanning_alert_location external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at before: type: string nullable: true check_runs_url: type: string format: uri conclusion: description: >- The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has `completed`. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - - skipped - startup_failure created_at: type: string format: date-time head_branch: description: The head branch name the changes are on. type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_sha: description: The SHA of the head commit that is being checked. type: string id: type: integer latest_check_runs_count: type: integer node_id: type: string pull_requests: description: >- An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base rerequestable: type: boolean runs_rerequestable: type: boolean status: description: >- The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. type: string nullable: true enum: - requested - in_progress - completed - queued - - pending updated_at: type: string format: date-time url: description: URL that points to the check suite API resource. type: string format: uri required: - id - node_id - head_branch - head_sha - status - conclusion - url - before - after - pull_requests - app - created_at - updated_at - latest_check_runs_count - check_runs_url - head_commit enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - check_suite - repository - sender webhook-check-suite-requested: title: check_suite requested event type: object properties: action: type: string enum: - requested example: requested check_suite: description: >- The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite). type: object properties: after: type: string nullable: true app: title: 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: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - workflow_job - merge_queue_entry - security_and_analysis - secret_scanning_alert_location - projects_v2_item - merge_group - repository_import external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at before: type: string nullable: true check_runs_url: type: string format: uri conclusion: description: >- The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - - skipped created_at: type: string format: date-time head_branch: description: The head branch name the changes are on. type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_sha: description: The SHA of the head commit that is being checked. type: string id: type: integer latest_check_runs_count: type: integer node_id: type: string pull_requests: description: >- An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base rerequestable: type: boolean runs_rerequestable: type: boolean status: description: >- The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. type: string nullable: true enum: - requested - in_progress - completed - queued - updated_at: type: string format: date-time url: description: URL that points to the check suite API resource. type: string format: uri required: - id - node_id - head_branch - head_sha - status - conclusion - url - before - after - pull_requests - app - created_at - updated_at - latest_check_runs_count - check_runs_url - head_commit enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - check_suite - repository - sender webhook-check-suite-rerequested: title: check_suite rerequested event type: object properties: action: type: string enum: - rerequested example: rerequested check_suite: description: >- The [check_suite](https://docs.github.com/enterprise-server@3.9/rest/checks/suites#get-a-check-suite). type: object properties: after: type: string nullable: true app: title: 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: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - merge_queue_entry - workflow_job external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at before: type: string nullable: true check_runs_url: type: string format: uri conclusion: description: >- The summary conclusion for all check runs that are part of the check suite. This value will be `null` until the check run has completed. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - created_at: type: string format: date-time head_branch: description: The head branch name the changes are on. type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_sha: description: The SHA of the head commit that is being checked. type: string id: type: integer latest_check_runs_count: type: integer node_id: type: string pull_requests: description: >- An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty. type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base rerequestable: type: boolean runs_rerequestable: type: boolean status: description: >- The summary status for all check runs that are part of the check suite. Can be `requested`, `in_progress`, or `completed`. type: string nullable: true enum: - requested - in_progress - completed - queued - updated_at: type: string format: date-time url: description: URL that points to the check suite API resource. type: string format: uri required: - id - node_id - head_branch - head_sha - status - conclusion - url - before - after - pull_requests - app - created_at - updated_at - latest_check_runs_count - check_runs_url - head_commit enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - check_suite - repository - sender webhook-code-scanning-alert-appeared-in-branch: title: code_scanning_alert appeared_in_branch event type: object properties: action: type: string enum: - appeared_in_branch example: appeared_in_branch alert: description: The code scanning alert involved in the event. type: object properties: created_at: description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` type: string format: date-time dismissed_at: description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. type: string nullable: true format: date-time dismissed_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id dismissed_reason: description: The reason for dismissing or closing the alert. type: string nullable: true enum: - false positive - won't fix - used in tests - html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: >- Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: >- Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: >- Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: >- The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string id: description: A unique identifier for the rule used to detect the alert. type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed tool: type: object properties: name: description: >- The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: >- The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: '12345678' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: description: >- The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-closed-by-user: title: code_scanning_alert closed_by_user event type: object properties: action: type: string enum: - closed_by_user example: closed_by_user alert: description: The code scanning alert involved in the event. type: object properties: created_at: description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` type: string format: date-time dismissed_at: description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. type: string format: date-time dismissed_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id dismissed_reason: description: The reason for dismissing or closing the alert. type: string nullable: true enum: - false positive - won't fix - used in tests - html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: >- Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: >- Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: >- Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: >- The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: >- A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - dismissed - fixed tool: type: object properties: guid: type: string nullable: true name: description: >- The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: >- The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: '12345678' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: description: >- The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-created: title: code_scanning_alert created event type: object properties: action: type: string enum: - created example: created alert: description: The code scanning alert involved in the event. type: object properties: created_at: description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` type: string nullable: true format: date-time dismissed_at: description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. nullable: true dismissed_by: nullable: true dismissed_comment: $ref: '#/components/schemas/code-scanning-alert-dismissed-comment' dismissed_reason: description: >- The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. nullable: true fixed_at: nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri instances_url: type: string most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: >- Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: >- Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: >- Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: >- The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: >- A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - open - dismissed tool: type: object nullable: true properties: guid: type: string nullable: true name: description: >- The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version updated_at: type: string nullable: true url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: >- The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: '12345678' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: description: >- The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-fixed: title: code_scanning_alert fixed event type: object properties: action: type: string enum: - fixed example: fixed alert: description: The code scanning alert involved in the event. type: object properties: created_at: description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` type: string format: date-time dismissed_at: description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. type: string nullable: true format: date-time dismissed_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id dismissed_reason: description: The reason for dismissing or closing the alert. type: string nullable: true enum: - false positive - won't fix - used in tests - html_url: description: The GitHub URL of the alert resource. type: string format: uri instances_url: type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: >- Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: >- Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: >- Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: >- The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: >- A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - fixed tool: type: object properties: guid: type: string nullable: true name: description: >- The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: >- The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: '12345678' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: description: >- The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-reopened: title: code_scanning_alert reopened event type: object properties: action: type: string enum: - reopened example: reopened alert: description: The code scanning alert involved in the event. type: object nullable: true properties: created_at: description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` type: string format: date-time dismissed_at: description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. type: string nullable: true dismissed_by: type: object nullable: true dismissed_reason: description: >- The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. type: string nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: >- Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: >- Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: >- Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: >- The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string full_description: type: string help: type: string nullable: true help_uri: description: >- A link to the documentation for the rule used to detect the alert. type: string nullable: true id: description: A unique identifier for the rule used to detect the alert. type: string name: type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - tags: type: array nullable: true items: type: string required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed tool: type: object properties: guid: type: string nullable: true name: description: >- The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: >- The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true example: '12345678' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: description: >- The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string nullable: true example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - ref - commit_oid - repository - sender webhook-code-scanning-alert-reopened-by-user: title: code_scanning_alert reopened_by_user event type: object properties: action: type: string enum: - reopened_by_user example: reopened_by_user alert: description: The code scanning alert involved in the event. type: object properties: created_at: description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ.` type: string format: date-time dismissed_at: description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. nullable: true dismissed_by: nullable: true dismissed_reason: description: >- The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`. nullable: true html_url: description: The GitHub URL of the alert resource. type: string format: uri most_recent_instance: title: Alert Instance type: object nullable: true properties: analysis_key: description: >- Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name. type: string category: description: >- Identifies the configuration under which the analysis was executed. type: string classifications: type: array items: type: string commit_sha: type: string environment: description: >- Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed. type: string location: type: object properties: end_column: type: integer end_line: type: integer path: type: string start_column: type: integer start_line: type: integer message: type: object properties: text: type: string ref: description: >- The full Git reference, formatted as `refs/heads/`. type: string state: description: State of a code scanning alert. type: string enum: - open - dismissed - fixed required: - ref - analysis_key - environment - state number: description: The code scanning alert number. type: integer rule: type: object properties: description: description: A short description of the rule used to detect the alert. type: string id: description: A unique identifier for the rule used to detect the alert. type: string severity: description: The severity of the alert. type: string nullable: true enum: - none - note - warning - error - required: - id - severity - description state: description: State of a code scanning alert. type: string enum: - open - fixed tool: type: object properties: name: description: >- The name of the tool used to generate the code scanning analysis alert. type: string version: description: The version of the tool used to detect the alert. type: string nullable: true required: - name - version url: type: string format: uri required: - number - created_at - url - html_url - state - dismissed_by - dismissed_at - dismissed_reason - rule - tool commit_oid: description: >- The commit SHA of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: '12345678' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: description: >- The Git reference of the code scanning alert. When the action is `reopened_by_user` or `closed_by_user`, the event was triggered by the `sender` and this value will be empty. type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - ref - commit_oid - repository - sender webhook-commit-comment-created: title: commit_comment created event type: object properties: action: description: The action performed. Can be `created`. type: string enum: - created example: created comment: description: >- The [commit comment](https://docs.github.com/enterprise-server@3.9/rest/commits/comments#get-a-commit-comment) resource. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string html_url: type: string format: uri id: description: The ID of the commit comment. type: integer line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the commit comment. type: string path: description: The relative path of the file to which the comment applies. type: string nullable: true position: description: The line index in the diff to which the comment applies. type: integer nullable: true reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - html_url - id - node_id - user - position - line - path - commit_id - created_at - updated_at - author_association - body enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - comment - repository - sender webhook-create: title: create event type: object properties: description: description: The repository's current description. type: string nullable: true example: This is an example repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' master_branch: description: The name of the repository's default branch (usually `main`). type: string example: main organization: $ref: '#/components/schemas/organization-simple-webhooks' pusher_type: description: The pusher type for the event. Can be either `user` or a deploy key. type: string example: User ref: description: >- The [`git ref`](https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference) resource. type: string example: main ref_type: description: The type of Git ref object created in the repository. type: string enum: - tag - branch example: tag repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - ref - ref_type - master_branch - description - pusher_type - repository - sender webhook-delete: title: delete event type: object properties: enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pusher_type: description: The pusher type for the event. Can be either `user` or a deploy key. type: string example: User ref: description: >- The [`git ref`](https://docs.github.com/enterprise-server@3.9/rest/git/refs#get-a-reference) resource. type: string example: main ref_type: description: The type of Git ref object deleted in the repository. type: string enum: - tag - branch example: tag repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - ref - ref_type - pusher_type - repository - sender webhook-dependabot-alert-created: title: Dependabot alert created event type: object properties: action: type: string enum: - created example: created alert: $ref: '#/components/schemas/dependabot-alert' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' enterprise: $ref: '#/components/schemas/enterprise-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-dependabot-alert-dismissed: title: Dependabot alert dismissed event type: object properties: action: type: string enum: - dismissed example: dismissed alert: $ref: '#/components/schemas/dependabot-alert' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' enterprise: $ref: '#/components/schemas/enterprise-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-dependabot-alert-fixed: title: Dependabot alert fixed event type: object properties: action: type: string enum: - fixed example: fixed alert: $ref: '#/components/schemas/dependabot-alert' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' enterprise: $ref: '#/components/schemas/enterprise-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-dependabot-alert-reintroduced: title: Dependabot alert reintroduced event type: object properties: action: type: string enum: - reintroduced example: reintroduced alert: $ref: '#/components/schemas/dependabot-alert' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' enterprise: $ref: '#/components/schemas/enterprise-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-dependabot-alert-reopened: title: Dependabot alert reopened event type: object properties: action: type: string enum: - reopened example: reopened alert: $ref: '#/components/schemas/dependabot-alert' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' enterprise: $ref: '#/components/schemas/enterprise-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-deploy-key-created: title: deploy_key created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' key: description: >- The [`deploy key`](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: added_by: type: string nullable: true created_at: type: string id: type: integer key: type: string last_used: type: string nullable: true read_only: type: boolean title: type: string url: type: string format: uri verified: type: boolean required: - id - key - url - title - verified - created_at - read_only organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - key - repository - sender webhook-deploy-key-deleted: title: deploy_key deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' key: description: >- The [`deploy key`](https://docs.github.com/enterprise-server@3.9/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource. type: object properties: added_by: type: string nullable: true created_at: type: string id: type: integer key: type: string last_used: type: string nullable: true read_only: type: boolean title: type: string url: type: string format: uri verified: type: boolean required: - id - key - url - title - verified - created_at - read_only organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - key - repository - sender webhook-deployment-created: title: deployment created event type: object properties: action: type: string enum: - created example: created deployment: title: Deployment description: >- The [deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments). type: object properties: created_at: type: string creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true environment: type: string id: type: integer node_id: type: string original_environment: type: string payload: oneOf: - type: object - type: string performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - workflow_job - pull_request_review_thread - merge_queue_entry - secret_scanning_alert_location - merge_group external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at production_environment: type: boolean ref: type: string repository_url: type: string format: uri sha: type: string statuses_url: type: string format: uri task: type: string transient_environment: type: boolean updated_at: type: string url: type: string format: uri required: - url - id - node_id - sha - ref - task - payload - original_environment - environment - description - creator - created_at - updated_at - statuses_url - repository_url enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow: title: Workflow type: object nullable: true properties: badge_url: type: string format: uri created_at: type: string format: date-time html_url: type: string format: uri id: type: integer name: type: string node_id: type: string path: type: string state: type: string updated_at: type: string format: date-time url: type: string format: uri required: - badge_url - created_at - html_url - id - name - node_id - path - state - updated_at - url workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - created_at: type: string format: date-time display_title: type: string event: type: string head_branch: type: string head_commit: nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - run_attempt - run_started_at - display_title required: - action - deployment - workflow - workflow_run - repository - sender webhook-deployment-review-approved: type: object properties: action: type: string enum: - approved example: approved approver: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string comment: type: string example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' reviewers: type: array items: type: object properties: reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id type: type: string enum: - User sender: $ref: '#/components/schemas/simple-user-webhooks' since: type: string example: example_value workflow_job_run: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: nullable: true status: type: string updated_at: type: string required: - id - name - status - conclusion - html_url - created_at - updated_at - environment workflow_job_runs: type: array items: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: type: string nullable: true status: type: string updated_at: type: string workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - created_at: type: string format: date-time display_title: type: string event: type: string head_branch: type: string head_commit: type: object nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - workflow_run - since - repository - organization - sender webhook-deployment-review-rejected: type: object properties: action: type: string enum: - rejected example: rejected approver: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string comment: type: string example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' reviewers: type: array items: type: object properties: reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id type: type: string enum: - User sender: $ref: '#/components/schemas/simple-user-webhooks' since: type: string example: example_value workflow_job_run: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: nullable: true status: type: string updated_at: type: string required: - id - name - status - conclusion - html_url - created_at - updated_at - environment workflow_job_runs: type: array items: type: object properties: conclusion: type: string nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: type: string nullable: true status: type: string updated_at: type: string workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - created_at: type: string format: date-time event: type: string head_branch: type: string head_commit: type: object nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string display_title: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - workflow_run - since - repository - organization - sender webhook-deployment-review-requested: type: object properties: action: type: string enum: - requested example: requested enterprise: $ref: '#/components/schemas/enterprise-webhooks' environment: type: string example: example_value installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' requestor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id reviewers: type: array items: type: object properties: reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - id type: type: string enum: - User - Team sender: $ref: '#/components/schemas/simple-user-webhooks' since: type: string example: example_value workflow_job_run: type: object properties: conclusion: nullable: true created_at: type: string environment: type: string html_url: type: string id: type: integer name: type: string nullable: true status: type: string updated_at: type: string required: - id - name - status - conclusion - html_url - created_at - updated_at - environment workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - created_at: type: string format: date-time event: type: string head_branch: type: string head_commit: type: object nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string display_title: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - workflow_run - since - workflow_job_run - environment - reviewers - requestor - repository - organization - sender webhook-deployment-status-created: title: deployment_status created event type: object properties: action: type: string enum: - created example: created check_run: type: object nullable: true properties: completed_at: type: string nullable: true format: date-time conclusion: description: >- The result of the completed check run. This value will be `null` until the check run has completed. type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - skipped - details_url: type: string format: uri external_id: type: string head_sha: description: The SHA of the commit that is being checked. type: string html_url: type: string format: uri id: description: The id of the check. type: integer name: description: The name of the check run. type: string node_id: type: string started_at: type: string format: date-time status: description: >- The current status of the check run. Can be `queued`, `in_progress`, or `completed`. type: string enum: - queued - in_progress - completed - waiting - pending url: type: string format: uri required: - id - name - node_id - head_sha - external_id - url - html_url - details_url - status - conclusion - started_at - completed_at deployment: title: Deployment description: >- The [deployment](https://docs.github.com/enterprise-server@3.9/rest/deployments/deployments#list-deployments). type: object properties: created_at: type: string creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true environment: type: string id: type: integer node_id: type: string original_environment: type: string payload: oneOf: - type: string - type: object nullable: true performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - merge_queue_entry - workflow_job - pull_request_review_thread - secret_scanning_alert_location - merge_group external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at production_environment: type: boolean ref: type: string repository_url: type: string format: uri sha: type: string statuses_url: type: string format: uri task: type: string transient_environment: type: boolean updated_at: type: string url: type: string format: uri required: - url - id - node_id - sha - ref - task - payload - original_environment - environment - description - creator - created_at - updated_at - statuses_url - repository_url deployment_status: description: >- The [deployment status](https://docs.github.com/enterprise-server@3.9/rest/deployments/statuses#list-deployment-statuses). type: object properties: created_at: type: string creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id deployment_url: type: string format: uri description: description: The optional human-readable description added to the status. type: string environment: type: string environment_url: type: string format: uri id: type: integer log_url: type: string format: uri node_id: type: string performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - merge_queue_entry - workflow_job - merge_group - secret_scanning_alert_location external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at repository_url: type: string format: uri state: description: >- The new state. Can be `pending`, `success`, `failure`, or `error`. type: string target_url: description: The optional link added to the status. type: string updated_at: type: string url: type: string format: uri required: - url - id - node_id - state - creator - description - environment - target_url - created_at - updated_at - deployment_url - repository_url enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow: title: Workflow type: object nullable: true properties: badge_url: type: string format: uri created_at: type: string format: date-time html_url: type: string format: uri id: type: integer name: type: string node_id: type: string path: type: string state: type: string updated_at: type: string format: date-time url: type: string format: uri required: - badge_url - created_at - html_url - id - name - node_id - path - state - updated_at - url workflow_run: title: Deployment Workflow Run type: object nullable: true properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - - startup_failure created_at: type: string format: date-time display_title: type: string event: type: string head_branch: type: string head_commit: nullable: true head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string logs_url: type: string name: type: string node_id: type: string path: type: string previous_attempt_url: nullable: true pull_requests: type: array items: title: Check Run Pull Request type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: integer number: type: integer url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - waiting - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string required: - id - name - node_id - head_branch - head_sha - run_number - event - status - conclusion - workflow_id - check_suite_id - check_suite_node_id - url - html_url - path - pull_requests - created_at - updated_at - actor - triggering_actor - run_attempt - run_started_at - display_title required: - action - deployment_status - deployment - repository - sender webhook-discussion-answered: title: discussion answered event type: object properties: action: type: string enum: - answered example: answered answer: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string format: date-time discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: nullable: true reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - answer - repository - sender webhook-discussion-category-changed: title: discussion category changed event type: object properties: action: type: string enum: - category_changed example: category_changed changes: type: object properties: category: type: object properties: from: type: object properties: created_at: type: string format: date-time description: type: string emoji: type: string id: type: integer is_answerable: type: boolean name: type: string node_id: type: string repository_id: type: integer slug: type: string updated_at: type: string required: - id - repository_id - emoji - name - description - created_at - updated_at - slug - is_answerable required: - from required: - category discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - discussion - repository - sender webhook-discussion-closed: title: discussion closed event type: object properties: action: type: string enum: - closed example: closed discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-comment-created: title: discussion_comment created event type: object properties: action: type: string enum: - created example: created comment: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: type: integer nullable: true reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body - reactions discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - comment - discussion - repository - sender webhook-discussion-comment-deleted: title: discussion_comment deleted event type: object properties: action: type: string enum: - deleted example: deleted comment: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: type: integer nullable: true reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body - reactions discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - comment - discussion - repository - sender webhook-discussion-comment-edited: title: discussion_comment edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: body: type: object properties: from: type: string required: - from required: - body comment: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: type: integer nullable: true reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body - reactions discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - comment - discussion - repository - sender webhook-discussion-created: title: discussion created event type: object properties: action: type: string enum: - created example: created discussion: allOf: - title: Discussion type: object properties: active_lock_reason: type: string nullable: true answer_chosen_at: type: string nullable: true answer_chosen_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id answer_html_url: type: string nullable: true author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string nullable: true category: type: object properties: created_at: type: string format: date-time description: type: string emoji: type: string id: type: integer is_answerable: type: boolean name: type: string node_id: type: string repository_id: type: integer slug: type: string updated_at: type: string required: - id - repository_id - emoji - name - description - created_at - updated_at - slug - is_answerable comments: type: integer created_at: type: string format: date-time html_url: type: string id: type: integer locked: type: boolean node_id: type: string number: type: integer reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string state: type: string enum: - open - locked - converting - transferring timeline_url: type: string title: type: string updated_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - repository_url - category - answer_html_url - answer_chosen_at - answer_chosen_by - html_url - id - node_id - number - title - user - state - locked - comments - created_at - updated_at - author_association - active_lock_reason - body - type: object properties: active_lock_reason: nullable: true answer_chosen_at: nullable: true answer_chosen_by: nullable: true answer_html_url: type: string nullable: true author_association: type: string body: type: string nullable: true category: type: object properties: created_at: type: string description: type: string emoji: type: string id: type: integer is_answerable: type: boolean name: type: string node_id: type: string repository_id: type: integer slug: type: string updated_at: type: string comments: type: integer created_at: type: string html_url: type: string id: type: integer locked: type: boolean enum: - false node_id: type: string number: type: integer reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string enum: - open - converting - transferring timeline_url: type: string title: type: string updated_at: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - state - locked - answer_html_url - answer_chosen_at - answer_chosen_by example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-deleted: title: discussion deleted event type: object properties: action: type: string enum: - deleted example: deleted discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-edited: title: discussion edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: body: type: object properties: from: type: string required: - from title: type: object properties: from: type: string required: - from discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-labeled: title: discussion labeled event type: object properties: action: type: string enum: - labeled example: labeled discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - label - repository - sender webhook-discussion-locked: title: discussion locked event type: object properties: action: type: string enum: - locked example: locked discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-pinned: title: discussion pinned event type: object properties: action: type: string enum: - pinned example: pinned discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-reopened: title: discussion reopened event type: object properties: action: type: string enum: - reopened example: reopened discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-transferred: title: discussion transferred event type: object properties: action: type: string enum: - transferred example: transferred changes: type: object properties: new_discussion: $ref: '#/components/schemas/discussion' new_repository: $ref: '#/components/schemas/repository-webhooks' required: - new_discussion - new_repository discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - discussion - repository - sender webhook-discussion-unanswered: title: discussion unanswered event type: object properties: action: type: string enum: - unanswered example: unanswered discussion: $ref: '#/components/schemas/discussion' old_answer: type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: type: string child_comment_count: type: integer created_at: type: string format: date-time discussion_id: type: integer html_url: type: string id: type: integer node_id: type: string parent_id: nullable: true reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string updated_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - html_url - parent_id - child_comment_count - repository_url - discussion_id - author_association - user - created_at - updated_at - body organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - old_answer - repository webhook-discussion-unlabeled: title: discussion unlabeled event type: object properties: action: type: string enum: - unlabeled example: unlabeled discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - label - repository - sender webhook-discussion-unlocked: title: discussion unlocked event type: object properties: action: type: string enum: - unlocked example: unlocked discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-discussion-unpinned: title: discussion unpinned event type: object properties: action: type: string enum: - unpinned example: unpinned discussion: $ref: '#/components/schemas/discussion' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - discussion - repository - sender webhook-enterprise-anonymous-access-disabled: type: object properties: action: type: string enum: - anonymous_access_disabled example: anonymous_access_disabled sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action webhook-enterprise-anonymous-access-enabled: type: object properties: action: type: string enum: - anonymous_access_enabled example: anonymous_access_enabled sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action webhook-fork: title: fork event description: A user forks a repository. type: object properties: enterprise: $ref: '#/components/schemas/enterprise-webhooks' forkee: description: >- The created [`repository`](https://docs.github.com/enterprise-server@3.9/rest/repos/repos#get-a-repository) resource. allOf: - title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time custom_properties: type: object description: >- The custom properties that were defined for the repository. The keys are the custom property names, and the values are the corresponding custom property values. additionalProperties: true default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility - type: object properties: allow_forking: type: boolean archive_url: type: string archived: type: boolean assignees_url: type: string blobs_url: type: string branches_url: type: string clone_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string created_at: type: string default_branch: type: string deployments_url: type: string description: type: string nullable: true disabled: type: boolean downloads_url: type: string events_url: type: string fork: type: boolean enum: - true forks: type: integer forks_count: type: integer forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string git_url: type: string has_downloads: type: boolean has_issues: type: boolean has_pages: type: boolean has_projects: type: boolean has_wiki: type: boolean homepage: type: string nullable: true hooks_url: type: string html_url: type: string id: type: integer is_template: type: boolean issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string language: nullable: true languages_url: type: string license: type: object nullable: true merges_url: type: string milestones_url: type: string mirror_url: nullable: true name: type: string node_id: type: string notifications_url: type: string open_issues: type: integer open_issues_count: type: integer owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean public: type: boolean pulls_url: type: string pushed_at: type: string releases_url: type: string size: type: integer ssh_url: type: string stargazers_count: type: integer stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string svn_url: type: string tags_url: type: string teams_url: type: string topics: type: array items: nullable: true trees_url: type: string updated_at: type: string url: type: string visibility: type: string watchers: type: integer watchers_count: type: integer properties: {} example: example_value installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - forkee - repository - sender webhook-github-app-authorization-revoked: title: github_app_authorization revoked event type: object properties: action: type: string enum: - revoked example: revoked sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - sender webhook-gollum: title: gollum event type: object properties: enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pages: description: The pages that were updated. type: array items: type: object properties: action: description: >- The action that was performed on the page. Can be `created` or `edited`. type: string enum: - created - edited html_url: description: Points to the HTML wiki page. type: string format: uri page_name: description: The name of the page. type: string sha: description: The latest commit SHA of the page. type: string summary: type: string nullable: true title: description: The current page title. type: string required: - page_name - title - summary - action - sha - html_url repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - pages - repository - sender webhook-installation-created: title: installation created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories: description: An array of repository objects that the installation can access. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: $ref: '#/components/schemas/repository-webhooks' requester: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - sender webhook-installation-deleted: title: installation deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories: description: An array of repository objects that the installation can access. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: $ref: '#/components/schemas/repository-webhooks' requester: nullable: true example: example_value sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - sender webhook-installation-new-permissions-accepted: title: installation new_permissions_accepted event type: object properties: action: type: string enum: - new_permissions_accepted example: new_permissions_accepted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories: description: An array of repository objects that the installation can access. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: $ref: '#/components/schemas/repository-webhooks' requester: nullable: true example: example_value sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - sender webhook-installation-repositories-added: title: installation_repositories added event type: object properties: action: type: string enum: - added example: added enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories_added: description: >- An array of repository objects, which were added to the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repositories_removed: description: >- An array of repository objects, which were removed from the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean repository: $ref: '#/components/schemas/repository-webhooks' repository_selection: description: >- Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected example: all requester: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - repository_selection - repositories_added - repositories_removed - requester - sender webhook-installation-repositories-removed: title: installation_repositories removed event type: object properties: action: type: string enum: - removed example: removed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories_added: description: >- An array of repository objects, which were added to the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repositories_removed: description: >- An array of repository objects, which were removed from the installation. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: $ref: '#/components/schemas/repository-webhooks' repository_selection: description: >- Describe whether all repositories have been selected or there's a selection involved type: string enum: - all - selected example: all requester: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - repository_selection - repositories_added - repositories_removed - requester - sender webhook-installation-suspend: title: installation suspend event type: object properties: action: type: string enum: - suspend example: suspend enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories: description: An array of repository objects that the installation can access. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: $ref: '#/components/schemas/repository-webhooks' requester: nullable: true example: example_value sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - sender webhook-installation-target-renamed: type: object properties: account: type: object properties: avatar_url: type: string created_at: type: string description: nullable: true events_url: type: string followers: type: integer followers_url: type: string following: type: integer following_url: type: string gists_url: type: string gravatar_id: type: string has_organization_projects: type: boolean has_repository_projects: type: boolean hooks_url: type: string html_url: type: string id: type: integer is_verified: type: boolean issues_url: type: string login: type: string members_url: type: string name: type: string node_id: type: string organizations_url: type: string public_gists: type: integer public_members_url: type: string public_repos: type: integer received_events_url: type: string repos_url: type: string site_admin: type: boolean slug: type: string starred_url: type: string subscriptions_url: type: string type: type: string updated_at: type: string url: type: string website_url: nullable: true required: - id - node_id - avatar_url - html_url action: type: string enum: - renamed example: renamed changes: type: object properties: login: type: object properties: from: type: string required: - from slug: type: object properties: from: type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' target_type: type: string example: User required: - action - target_type - account - changes - installation webhook-installation-unsuspend: title: installation unsuspend event type: object properties: action: type: string enum: - unsuspend example: unsuspend enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repositories: description: An array of repository objects that the installation can access. type: array items: type: object properties: full_name: type: string id: description: Unique identifier of the repository type: integer name: description: The name of the repository. type: string node_id: type: string private: description: Whether the repository is private or public. type: boolean required: - id - node_id - name - full_name - private repository: $ref: '#/components/schemas/repository-webhooks' requester: nullable: true example: example_value sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - installation - sender webhook-issue-comment-created: title: issue_comment created event type: object properties: action: type: string enum: - created example: created comment: title: issue comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue comment type: string created_at: type: string format: date-time html_url: type: string format: uri id: description: Unique identifier of the issue comment type: integer format: int64 issue_url: type: string format: uri node_id: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string format: date-time url: description: URL for the issue comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - html_url - issue_url - id - node_id - user - created_at - updated_at - author_association - performed_via_github_app - body - reactions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - labels - state - locked - assignee example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - comment - repository - sender webhook-issue-comment-deleted: title: issue_comment deleted event type: object properties: action: type: string enum: - deleted example: deleted comment: title: issue comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue comment type: string created_at: type: string format: date-time html_url: type: string format: uri id: description: Unique identifier of the issue comment type: integer format: int64 issue_url: type: string format: uri node_id: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string format: date-time url: description: URL for the issue comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - html_url - issue_url - id - node_id - user - created_at - updated_at - author_association - performed_via_github_app - body - reactions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - labels - state - locked - assignee example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - comment - repository - sender webhook-issue-comment-edited: title: issue_comment edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the comment. type: object properties: body: type: object properties: from: description: The previous version of the body. type: string required: - from comment: title: issue comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/issues/comments#get-an-issue-comment) itself. type: object properties: author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue comment type: string created_at: type: string format: date-time html_url: type: string format: uri id: description: Unique identifier of the issue comment type: integer format: int64 issue_url: type: string format: uri node_id: type: string performed_via_github_app: $ref: '#/components/schemas/nullable-integration' reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket updated_at: type: string format: date-time url: description: URL for the issue comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - html_url - issue_url - id - node_id - user - created_at - updated_at - author_association - performed_via_github_app - body - reactions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) the comment belongs to. allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - labels - state - locked - assignee example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - issue - comment - repository - sender webhook-issues-assigned: title: issues assigned event type: object properties: action: description: The action that was performed. type: string enum: - assigned example: assigned assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-closed: title: issues closed event type: object properties: action: description: The action that was performed. type: string enum: - closed example: closed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - security_and_analysis - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: type: object nullable: true assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: type: object nullable: true labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string enum: - closed - open timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - state - closed_at example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-deleted: title: issues deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-demilestoned: title: issues demilestoned event type: object properties: action: type: string enum: - demilestoned example: demilestoned enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: type: object nullable: true assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: type: object nullable: true labels_url: type: string locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - milestone example: example_value milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-edited: title: issues edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the issue. type: object properties: body: type: object properties: from: description: The previous version of the body. type: string required: - from title: type: object properties: from: description: The previous version of the title. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - security_and_analysis - pull_request_review_thread - reminder external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - issue - repository - sender webhook-issues-labeled: title: issues labeled event type: object properties: action: type: string enum: - labeled example: labeled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - reminder external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-locked: title: issues locked event type: object properties: action: type: string enum: - locked example: locked enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - security_and_analysis external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: type: object nullable: true assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: type: object nullable: true labels_url: type: string locked: type: boolean enum: - true milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - locked - active_lock_reason example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-milestoned: title: issues milestoned event type: object properties: action: type: string enum: - milestoned example: milestoned enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: type: object nullable: true assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: type: object nullable: true labels_url: type: string locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - milestone example: example_value milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - milestone - repository - sender webhook-issues-opened: title: issues opened event type: object properties: action: type: string enum: - opened example: opened changes: type: object properties: old_issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object nullable: true properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions old_repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_discussions: description: Whether the repository has discussions enabled. type: boolean has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: Whether to require commit signoff. type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility required: - old_issue - old_repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - security_and_analysis - pull_request_review_thread - reminder external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-pinned: title: issues pinned event type: object properties: action: type: string enum: - pinned example: pinned enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-reopened: title: issues reopened event type: object properties: action: type: string enum: - reopened example: reopened enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - pull_request_review_thread - reminder external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write - admin secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: type: string nullable: true assignee: type: object nullable: true assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: type: object nullable: true labels_url: type: string locked: type: boolean milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: type: object nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string enum: - open - closed timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - state example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-transferred: title: issues transferred event type: object properties: action: type: string enum: - transferred example: transferred changes: type: object properties: new_issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions new_repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility required: - new_issue - new_repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - issue - repository - sender webhook-issues-unassigned: title: issues unassigned event type: object properties: action: description: The action that was performed. type: string enum: - unassigned example: unassigned assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-unlabeled: title: issues unlabeled event type: object properties: action: type: string enum: - unlabeled example: unlabeled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run - reminder - pull_request_review_thread external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write - admin organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-unlocked: title: issues unlocked event type: object properties: action: type: string enum: - unlocked example: unlocked enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: allOf: - title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions - type: object properties: active_lock_reason: nullable: true assignee: type: object nullable: true assignees: type: array items: type: object nullable: true author_association: type: string body: type: string nullable: true closed_at: type: string nullable: true comments: type: integer comments_url: type: string created_at: type: string events_url: type: string html_url: type: string id: type: integer labels: type: array items: type: object nullable: true labels_url: type: string locked: type: boolean enum: - false milestone: type: object nullable: true node_id: type: string number: type: integer performed_via_github_app: nullable: true reactions: type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string repository_url: type: string state: type: string timeline_url: type: string title: type: string updated_at: type: string url: type: string user: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - locked - active_lock_reason example: example_value organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-issues-unpinned: title: issues unpinned event type: object properties: action: type: string enum: - unpinned example: unpinned enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' issue: title: Issue description: >- The [issue](https://docs.github.com/enterprise-server@3.9/rest/issues/issues#get-an-issue) itself. type: object properties: active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: Contents of the issue type: string nullable: true closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri created_at: type: string format: date-time draft: type: boolean events_url: type: string format: uri html_url: type: string format: uri id: type: integer format: int64 labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description labels_url: type: string format: uri-template locked: type: boolean milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer performed_via_github_app: title: 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 nullable: true properties: created_at: type: string nullable: true format: date-time description: type: string nullable: true events: description: The list of events for the GitHub app type: array items: type: string enum: - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - content_reference - create - delete - deployment - deployment_review - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - milestone - organization - org_block - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - push - registry_package - release - repository - repository_dispatch - secret_scanning_alert - star - status - team - team_add - watch - workflow_dispatch - workflow_run external_url: type: string nullable: true format: uri html_url: type: string format: uri id: description: Unique identifier of the GitHub app type: integer nullable: true name: description: The name of the GitHub app type: string node_id: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: description: The set of permissions for the GitHub app type: object properties: actions: type: string enum: - read - write administration: type: string enum: - read - write checks: type: string enum: - read - write content_references: type: string enum: - read - write contents: type: string enum: - read - write deployments: type: string enum: - read - write discussions: type: string enum: - read - write emails: type: string enum: - read - write environments: type: string enum: - read - write issues: type: string enum: - read - write keys: type: string enum: - read - write members: type: string enum: - read - write metadata: type: string enum: - read - write organization_administration: type: string enum: - read - write organization_hooks: type: string enum: - read - write organization_packages: type: string enum: - read - write organization_plan: type: string enum: - read - write organization_projects: type: string enum: - read - write organization_secrets: type: string enum: - read - write organization_self_hosted_runners: type: string enum: - read - write organization_user_blocking: type: string enum: - read - write packages: type: string enum: - read - write pages: type: string enum: - read - write pull_requests: type: string enum: - read - write repository_hooks: type: string enum: - read - write repository_projects: type: string enum: - read - write secret_scanning_alerts: type: string enum: - read - write secrets: type: string enum: - read - write security_events: type: string enum: - read - write security_scanning_alert: type: string enum: - read - write single_file: type: string enum: - read - write statuses: type: string enum: - read - write team_discussions: type: string enum: - read - write vulnerability_alerts: type: string enum: - read - write workflows: type: string enum: - read - write slug: description: The slug name of the GitHub app type: string updated_at: type: string nullable: true format: date-time required: - id - node_id - owner - name - description - external_url - html_url - created_at - updated_at pull_request: type: object properties: diff_url: type: string format: uri html_url: type: string format: uri merged_at: type: string nullable: true format: date-time patch_url: type: string format: uri url: type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string format: uri state: description: State of the issue; either 'open' or 'closed' type: string enum: - open - closed state_reason: type: string nullable: true timeline_url: type: string format: uri title: description: Title of the issue type: string updated_at: type: string format: date-time url: description: URL for the issue type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - repository_url - labels_url - comments_url - events_url - html_url - id - node_id - number - title - user - assignees - milestone - comments - created_at - updated_at - closed_at - author_association - active_lock_reason - body - reactions organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - issue - repository - sender webhook-label-created: title: label created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - label - repository webhook-label-deleted: title: label deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - label - repository - sender webhook-label-edited: title: label edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the label if the action was `edited`. type: object properties: color: type: object properties: from: description: >- The previous version of the color if the action was `edited`. type: string required: - from description: type: object properties: from: description: >- The previous version of the description if the action was `edited`. type: string required: - from name: type: object properties: from: description: The previous version of the name if the action was `edited`. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - label - repository - sender webhook-member-added: title: member added event type: object properties: action: type: string enum: - added example: added changes: type: object properties: permission: description: >- This field is included for legacy purposes; use the `role_name` field instead. The `maintain` role is mapped to `write` and the `triage` role is mapped to `read`. To determine the role assigned to the collaborator, use the `role_name` field instead, which will provide the full role name, including custom roles. type: object properties: to: type: string enum: - write - admin - read required: - to role_name: description: The role assigned to the collaborator. type: object properties: to: type: string required: - to enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' member: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - member - repository - sender webhook-member-edited: title: member edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the collaborator permissions type: object properties: old_permission: type: object properties: from: description: >- The previous permissions of the collaborator if the action was edited. type: string required: - from permission: type: object properties: from: type: string nullable: true to: type: string nullable: true enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' member: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - member - repository - sender webhook-member-removed: title: member removed event type: object properties: action: type: string enum: - removed example: removed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' member: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - member - repository - sender webhook-membership-added: title: membership added event type: object properties: action: type: string enum: - added example: added enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' member: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' scope: description: The scope of the membership. Currently, can only be `team`. type: string enum: - team example: team sender: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - scope - member - sender - team - organization webhook-membership-removed: title: membership removed event type: object properties: action: type: string enum: - removed example: removed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' member: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' scope: description: The scope of the membership. Currently, can only be `team`. type: string enum: - team - organization example: team sender: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - scope - member - sender - team - organization webhook-meta-deleted: title: meta deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' hook: description: >- The modified webhook. This will contain different keys based on the type of webhook it is: repository, organization, business, app, or GitHub Marketplace. type: object properties: active: type: boolean config: type: object properties: content_type: type: string enum: - json - form insecure_ssl: type: string secret: type: string url: type: string format: uri required: - content_type - insecure_ssl - url created_at: type: string events: type: array items: type: string enum: - '*' - branch_protection_rule - check_run - check_suite - code_scanning_alert - commit_comment - create - delete - deployment - deployment_status - deploy_key - discussion - discussion_comment - fork - gollum - issues - issue_comment - label - member - membership - meta - milestone - organization - org_block - package - page_build - project - project_card - project_column - public - pull_request - pull_request_review - pull_request_review_comment - pull_request_review_thread - push - registry_package - release - repository - repository_import - repository_vulnerability_alert - secret_scanning_alert - secret_scanning_alert_location - security_and_analysis - star - status - team - team_add - watch - workflow_job - workflow_run - repository_dispatch - projects_v2_item minItems: 1 id: type: integer name: type: string type: type: string updated_at: type: string required: - type - id - name - active - events - config - updated_at - created_at hook_id: description: The id of the modified webhook. type: integer example: 42 installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/nullable-repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - hook_id - hook webhook-milestone-closed: title: milestone closed event type: object properties: action: type: string enum: - closed example: closed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - milestone - repository - sender webhook-milestone-created: title: milestone created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - milestone - repository - sender webhook-milestone-deleted: title: milestone deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - milestone - repository - sender webhook-milestone-edited: title: milestone edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the milestone if the action was `edited`. type: object properties: description: type: object properties: from: description: >- The previous version of the description if the action was `edited`. type: string required: - from due_on: type: object properties: from: description: >- The previous version of the due date if the action was `edited`. type: string required: - from title: type: object properties: from: description: >- The previous version of the title if the action was `edited`. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - milestone - repository - sender webhook-milestone-opened: title: milestone opened event type: object properties: action: type: string enum: - opened example: opened enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' milestone: title: Milestone description: A collection of related issues and pull requests. type: object properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - milestone - repository - sender webhook-organization-deleted: title: organization deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' membership: title: Membership description: >- The membership between the user and the organization. Not present when the action is `member_invited`. type: object properties: organization_url: type: string format: uri role: type: string state: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - state - role - organization_url - user organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - organization - sender webhook-organization-member-added: title: organization member_added event type: object properties: action: type: string enum: - member_added example: member_added enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' membership: title: Membership description: >- The membership between the user and the organization. Not present when the action is `member_invited`. type: object properties: organization_url: type: string format: uri role: type: string state: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - state - role - organization_url - user organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - membership - organization - sender webhook-organization-member-invited: title: organization member_invited event type: object properties: action: type: string enum: - member_invited example: member_invited enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' invitation: description: >- The invitation for the user or email if the action is `member_invited`. type: object properties: created_at: type: string format: date-time email: type: string nullable: true failed_at: type: string nullable: true format: date-time failed_reason: type: string nullable: true id: type: number invitation_teams_url: type: string format: uri inviter: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id login: type: string nullable: true node_id: type: string role: type: string team_count: type: number invitation_source: type: string required: - id - node_id - login - email - role - created_at - failed_at - failed_reason - inviter - team_count - invitation_teams_url organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - action - invitation - organization - sender webhook-organization-member-removed: title: organization member_removed event type: object properties: action: type: string enum: - member_removed example: member_removed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' membership: title: Membership description: >- The membership between the user and the organization. Not present when the action is `member_invited`. type: object properties: organization_url: type: string format: uri role: type: string state: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - state - role - organization_url - user organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - membership - organization - sender webhook-organization-renamed: title: organization renamed event type: object properties: action: type: string enum: - renamed example: renamed changes: type: object properties: login: type: object properties: from: type: string enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' membership: title: Membership description: >- The membership between the user and the organization. Not present when the action is `member_invited`. type: object properties: organization_url: type: string format: uri role: type: string state: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - state - role - organization_url - user organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - organization - sender webhook-package-published: title: package published event type: object properties: action: type: string enum: - published example: published enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' package: description: Information about the package. type: object properties: created_at: type: string nullable: true description: type: string nullable: true ecosystem: type: string html_url: type: string format: uri id: type: integer name: type: string namespace: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id package_type: type: string package_version: type: object nullable: true properties: author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: oneOf: - type: string - type: object body_html: type: string container_metadata: type: object nullable: true properties: labels: type: object nullable: true manifest: type: object nullable: true tag: type: object properties: digest: type: string name: type: string created_at: type: string description: type: string docker_metadata: type: array items: type: object properties: tags: type: array items: type: string draft: type: boolean html_url: type: string format: uri id: type: integer installation_command: type: string manifest: type: string metadata: type: array items: type: object additionalProperties: true name: type: string npm_metadata: type: object nullable: true properties: name: type: string version: type: string npm_user: type: string author: type: object nullable: true bugs: type: object nullable: true dependencies: type: object dev_dependencies: type: object peer_dependencies: type: object optional_dependencies: type: object description: type: string dist: type: object nullable: true git_head: type: string homepage: type: string license: type: string main: type: string repository: type: object nullable: true scripts: type: object id: type: string node_version: type: string npm_version: type: string has_shrinkwrap: type: boolean maintainers: type: array items: type: object contributors: type: array items: type: object engines: type: object keywords: type: array items: type: string files: type: array items: type: string bin: type: object man: type: object directories: type: object nullable: true os: type: array items: type: string cpu: type: array items: type: string readme: type: string installation_command: type: string release_id: type: integer commit_oid: type: string published_via_actions: type: boolean deleted_by_id: type: integer nuget_metadata: type: array nullable: true items: type: object properties: id: oneOf: - type: integer - type: string name: type: string value: oneOf: - type: boolean - type: string - type: integer - type: object properties: url: type: string branch: type: string commit: type: string type: type: string package_files: type: array items: type: object properties: content_type: type: string created_at: type: string download_url: type: string format: uri id: type: integer md5: type: string nullable: true name: type: string sha1: type: string nullable: true sha256: type: string nullable: true size: type: integer state: type: string nullable: true updated_at: type: string required: - download_url - id - name - sha256 - sha1 - md5 - content_type - state - size - created_at - updated_at package_url: type: string prerelease: type: boolean release: type: object properties: author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id created_at: type: string draft: type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true prerelease: type: boolean published_at: type: string tag_name: type: string target_commitish: type: string url: type: string format: uri required: - url - html_url - id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at rubygems_metadata: type: array items: $ref: '#/components/schemas/webhook-rubygems-metadata' source_url: type: string summary: type: string tag_name: type: string target_commitish: type: string target_oid: type: string updated_at: type: string version: type: string required: - id - version - summary - name - description - html_url - metadata - package_files - installation_command registry: type: object nullable: true properties: about_url: type: string format: uri name: type: string type: type: string url: type: string format: uri vendor: type: string required: - about_url - name - type - url - vendor updated_at: type: string nullable: true required: - id - name - namespace - description - ecosystem - package_type - html_url - created_at - updated_at - owner - package_version - registry repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - package - sender webhook-package-updated: title: package updated event type: object properties: action: type: string enum: - updated example: updated enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' package: description: Information about the package. type: object properties: created_at: type: string description: type: string nullable: true ecosystem: type: string html_url: type: string format: uri id: type: integer name: type: string namespace: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id package_type: type: string package_version: type: object properties: author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string body_html: type: string created_at: type: string description: type: string docker_metadata: type: array items: type: object properties: tags: type: array items: type: string draft: type: boolean html_url: type: string format: uri id: type: integer installation_command: type: string manifest: type: string metadata: type: array items: type: object additionalProperties: true name: type: string package_files: type: array items: type: object properties: content_type: type: string created_at: type: string download_url: type: string format: uri id: type: integer md5: type: string nullable: true name: type: string sha1: type: string nullable: true sha256: type: string size: type: integer state: type: string updated_at: type: string required: - download_url - id - name - sha256 - sha1 - md5 - content_type - state - size - created_at - updated_at package_url: type: string prerelease: type: boolean release: type: object properties: author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id created_at: type: string draft: type: boolean html_url: type: string format: uri id: type: integer name: type: string prerelease: type: boolean published_at: type: string tag_name: type: string target_commitish: type: string url: type: string format: uri required: - url - html_url - id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at rubygems_metadata: type: array items: $ref: '#/components/schemas/webhook-rubygems-metadata' source_url: type: string format: uri summary: type: string tag_name: type: string target_commitish: type: string target_oid: type: string updated_at: type: string version: type: string required: - id - version - summary - name - description - body - body_html - html_url - target_commitish - target_oid - created_at - updated_at - metadata - package_files - author - installation_command registry: type: object nullable: true properties: about_url: type: string format: uri name: type: string type: type: string url: type: string format: uri vendor: type: string required: - about_url - name - type - url - vendor updated_at: type: string required: - id - name - namespace - description - ecosystem - package_type - html_url - created_at - updated_at - owner - package_version - registry repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - package - repository - sender webhook-page-build: title: page_build event type: object properties: build: description: >- The [List GitHub Pages builds](https://docs.github.com/enterprise-server@3.9/rest/pages/pages#list-github-pages-builds) itself. type: object properties: commit: type: string nullable: true created_at: type: string duration: type: integer error: type: object properties: message: type: string nullable: true required: - message pusher: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id status: type: string updated_at: type: string url: type: string format: uri required: - url - status - error - pusher - commit - duration - created_at - updated_at enterprise: $ref: '#/components/schemas/enterprise-webhooks' id: type: integer example: 42 installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - id - build - repository - sender webhook-ping: type: object properties: hook: title: Webhook description: The webhook that is being pinged type: object properties: active: description: >- Determines whether the hook is actually triggered for the events it subscribes to. type: boolean app_id: description: >- Only included for GitHub Apps. When you register a new GitHub App, GitHub sends a ping event to the webhook URL you specified during registration. The GitHub App ID sent in this field is required for authenticating an app. type: integer config: type: object properties: content_type: $ref: '#/components/schemas/webhook-config-content-type' insecure_ssl: $ref: '#/components/schemas/webhook-config-insecure-ssl' secret: $ref: '#/components/schemas/webhook-config-secret' url: $ref: '#/components/schemas/webhook-config-url' created_at: type: string format: date-time deliveries_url: type: string format: uri events: description: >- Determines what events the hook is triggered for. Default: ['push']. type: array items: type: string id: description: Unique identifier of the webhook. type: integer last_response: $ref: '#/components/schemas/hook-response' name: description: The type of webhook. The only valid value is 'web'. type: string enum: - web ping_url: type: string format: uri test_url: type: string format: uri type: type: string updated_at: type: string format: date-time url: type: string format: uri required: - id - type - name - active - events - config - created_at - updated_at hook_id: description: The ID of the webhook that triggered the ping. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' zen: description: Random string of GitHub zen. type: string example: example_value webhook-ping-form-encoded: description: The webhooks ping payload encoded with URL encoding. type: object properties: payload: description: >- A URL-encoded string of the ping JSON payload. The decoded payload is a JSON object. type: string example: example_value required: - payload webhook-project-card-converted: title: project_card converted event type: object properties: action: type: string enum: - converted example: converted changes: type: object properties: note: type: object properties: from: type: string required: - from required: - note enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_card: title: Project Card type: object properties: after_id: type: integer nullable: true archived: description: Whether or not the card is archived type: boolean column_id: type: integer column_url: type: string format: uri content_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id id: description: The project card's ID type: integer node_id: type: string note: type: string nullable: true project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - column_url - column_id - id - node_id - note - archived - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - project_card - sender webhook-project-card-created: title: project_card created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_card: title: Project Card type: object properties: after_id: type: integer nullable: true archived: description: Whether or not the card is archived type: boolean column_id: type: integer column_url: type: string format: uri content_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id id: description: The project card's ID type: integer node_id: type: string note: type: string nullable: true project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - column_url - column_id - id - node_id - note - archived - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project_card - sender webhook-project-card-deleted: title: project_card deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_card: title: Project Card type: object properties: after_id: type: integer nullable: true archived: description: Whether or not the card is archived type: boolean column_id: type: integer nullable: true column_url: type: string format: uri content_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id id: description: The project card's ID type: integer node_id: type: string note: type: string nullable: true project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - column_url - column_id - id - node_id - note - archived - creator - created_at - updated_at repository: $ref: '#/components/schemas/nullable-repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project_card - sender webhook-project-card-edited: title: project_card edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: note: type: object properties: from: type: string nullable: true required: - from required: - note enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_card: title: Project Card type: object properties: after_id: type: integer nullable: true archived: description: Whether or not the card is archived type: boolean column_id: type: integer column_url: type: string format: uri content_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id id: description: The project card's ID type: integer node_id: type: string note: type: string nullable: true project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - column_url - column_id - id - node_id - note - archived - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - project_card - sender webhook-project-card-moved: title: project_card moved event type: object properties: action: type: string enum: - moved example: moved changes: type: object properties: column_id: type: object properties: from: type: integer required: - from required: - column_id enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_card: allOf: - title: Project Card type: object properties: after_id: type: integer nullable: true archived: description: Whether or not the card is archived type: boolean column_id: type: integer column_url: type: string format: uri content_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id id: description: The project card's ID type: integer node_id: type: string note: type: string nullable: true project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - column_url - column_id - id - node_id - note - archived - creator - created_at - updated_at - type: object properties: after_id: type: number nullable: true archived: type: boolean column_id: type: integer column_url: type: string created_at: type: string creator: type: object nullable: true properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string id: type: integer node_id: type: string note: type: string nullable: true project_url: type: string updated_at: type: string url: type: string required: - after_id example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project_card - sender webhook-project-closed: title: project closed event type: object properties: action: type: string enum: - closed example: closed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project: title: Project type: object properties: body: description: Body of the project type: string nullable: true columns_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id html_url: type: string format: uri id: type: integer name: description: Name of the project type: string node_id: type: string number: type: integer owner_url: type: string format: uri state: description: State of the project; either 'open' or 'closed' type: string enum: - open - closed updated_at: type: string format: date-time url: type: string format: uri required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project - sender webhook-project-column-created: title: project_column created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_column: title: Project Column type: object properties: after_id: type: integer nullable: true cards_url: type: string format: uri created_at: type: string format: date-time id: description: The unique identifier of the project column type: integer name: description: Name of the project column type: string node_id: type: string project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - cards_url - id - node_id - name - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project_column webhook-project-column-deleted: title: project_column deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_column: title: Project Column type: object properties: after_id: type: integer nullable: true cards_url: type: string format: uri created_at: type: string format: date-time id: description: The unique identifier of the project column type: integer name: description: Name of the project column type: string node_id: type: string project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - cards_url - id - node_id - name - created_at - updated_at repository: $ref: '#/components/schemas/nullable-repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project_column webhook-project-column-edited: title: project_column edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: name: type: object properties: from: type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_column: title: Project Column type: object properties: after_id: type: integer nullable: true cards_url: type: string format: uri created_at: type: string format: date-time id: description: The unique identifier of the project column type: integer name: description: Name of the project column type: string node_id: type: string project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - cards_url - id - node_id - name - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - project_column webhook-project-column-moved: title: project_column moved event type: object properties: action: type: string enum: - moved example: moved enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project_column: title: Project Column type: object properties: after_id: type: integer nullable: true cards_url: type: string format: uri created_at: type: string format: date-time id: description: The unique identifier of the project column type: integer name: description: Name of the project column type: string node_id: type: string project_url: type: string format: uri updated_at: type: string format: date-time url: type: string format: uri required: - url - project_url - cards_url - id - node_id - name - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project_column - sender webhook-project-created: title: project created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project: title: Project type: object properties: body: description: Body of the project type: string nullable: true columns_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id html_url: type: string format: uri id: type: integer name: description: Name of the project type: string node_id: type: string number: type: integer owner_url: type: string format: uri state: description: State of the project; either 'open' or 'closed' type: string enum: - open - closed updated_at: type: string format: date-time url: type: string format: uri required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project - sender webhook-project-deleted: title: project deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project: title: Project type: object properties: body: description: Body of the project type: string nullable: true columns_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id html_url: type: string format: uri id: type: integer name: description: Name of the project type: string node_id: type: string number: type: integer owner_url: type: string format: uri state: description: State of the project; either 'open' or 'closed' type: string enum: - open - closed updated_at: type: string format: date-time url: type: string format: uri required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at repository: $ref: '#/components/schemas/nullable-repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project webhook-project-edited: title: project edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the project if the action was `edited`. type: object properties: body: type: object properties: from: description: The previous version of the body if the action was `edited`. type: string required: - from name: type: object properties: from: description: The changes to the project if the action was `edited`. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project: title: Project type: object properties: body: description: Body of the project type: string nullable: true columns_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id html_url: type: string format: uri id: type: integer name: description: Name of the project type: string node_id: type: string number: type: integer owner_url: type: string format: uri state: description: State of the project; either 'open' or 'closed' type: string enum: - open - closed updated_at: type: string format: date-time url: type: string format: uri required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project webhook-project-reopened: title: project reopened event type: object properties: action: type: string enum: - reopened example: reopened enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' project: title: Project type: object properties: body: description: Body of the project type: string nullable: true columns_url: type: string format: uri created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id html_url: type: string format: uri id: type: integer name: description: Name of the project type: string node_id: type: string number: type: integer owner_url: type: string format: uri state: description: State of the project; either 'open' or 'closed' type: string enum: - open - closed updated_at: type: string format: date-time url: type: string format: uri required: - owner_url - url - html_url - columns_url - id - node_id - name - body - number - state - creator - created_at - updated_at repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - project - sender webhook-projects-v2-project-closed: title: Projects v2 Project Closed Event type: object properties: action: type: string enum: - closed example: closed installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2: $ref: '#/components/schemas/projects-v2' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2 - organization - sender webhook-projects-v2-project-created: description: A project was created type: object properties: action: type: string enum: - created example: created installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2: $ref: '#/components/schemas/projects-v2' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2 - organization - sender webhook-projects-v2-project-deleted: title: Projects v2 Project Deleted Event type: object properties: action: type: string enum: - deleted example: deleted installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2: $ref: '#/components/schemas/projects-v2' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2 - organization - sender webhook-projects-v2-project-edited: title: Projects v2 Project Edited Event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: description: type: object properties: from: type: string nullable: true to: type: string nullable: true public: type: object properties: from: type: boolean to: type: boolean short_description: type: object properties: from: type: string nullable: true to: type: string nullable: true title: type: object properties: from: type: string to: type: string installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2: $ref: '#/components/schemas/projects-v2' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2 - organization - sender - changes webhook-projects-v2-item-archived: title: Projects v2 Item Archived Event type: object properties: action: type: string enum: - archived example: archived changes: type: object properties: archived_at: type: object properties: from: type: string nullable: true format: date-time to: type: string nullable: true format: date-time installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender - changes webhook-projects-v2-item-converted: title: Projects v2 Item Converted Event type: object properties: action: type: string enum: - converted example: converted changes: type: object properties: content_type: type: object properties: from: type: string nullable: true to: type: string installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender - changes webhook-projects-v2-item-created: title: Projects v2 Item Created Event type: object properties: action: type: string enum: - created example: created installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender webhook-projects-v2-item-deleted: title: Projects v2 Item Deleted Event type: object properties: action: type: string enum: - deleted example: deleted installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender webhook-projects-v2-item-edited: title: Projects v2 Item Edited Event type: object properties: action: type: string enum: - edited example: edited changes: oneOf: - type: object properties: field_value: type: object properties: field_node_id: type: string field_type: type: string required: - field_value - type: object properties: body: type: object properties: from: type: string nullable: true to: type: string nullable: true required: - body example: example_value installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender webhook-projects-v2-item-reordered: title: Projects v2 Item Reordered Event type: object properties: action: type: string enum: - reordered example: reordered changes: type: object properties: previous_projects_v2_item_node_id: type: object properties: from: type: string nullable: true to: type: string nullable: true installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender - changes webhook-projects-v2-item-restored: title: Projects v2 Item Restored Event type: object properties: action: type: string enum: - restored example: restored changes: type: object properties: archived_at: type: object properties: from: type: string nullable: true format: date-time to: type: string nullable: true format: date-time installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2_item: $ref: '#/components/schemas/projects-v2-item' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2_item - organization - sender - changes webhook-projects-v2-project-reopened: title: Projects v2 Project Reopened Event type: object properties: action: type: string enum: - reopened example: reopened installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' projects_v2: $ref: '#/components/schemas/projects-v2' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - projects_v2 - organization - sender webhook-public: title: public event type: object properties: enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - repository - sender webhook-pull-request-assigned: title: pull_request assigned event type: object properties: action: type: string enum: - assigned example: assigned assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - assignee - repository - sender webhook-pull-request-auto-merge-disabled: title: pull_request auto_merge_disabled event type: object properties: action: type: string enum: - auto_merge_disabled example: auto_merge_disabled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft reason: type: string example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - reason - repository - sender webhook-pull-request-auto-merge-enabled: title: pull_request auto_merge_enabled event type: object properties: action: type: string enum: - auto_merge_enabled example: auto_merge_enabled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft reason: type: string example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-closed: title: pull_request closed event type: object properties: action: type: string enum: - closed example: closed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: allOf: - $ref: '#/components/schemas/pull-request' - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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"). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: 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.** type: boolean default: false example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-converted-to-draft: title: pull_request converted_to_draft event type: object properties: action: type: string enum: - converted_to_draft example: converted_to_draft enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: allOf: - $ref: '#/components/schemas/pull-request' - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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"). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: 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.** type: boolean default: false example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-demilestoned: title: pull_request demilestoned event type: object properties: action: type: string enum: - demilestoned example: demilestoned enterprise: $ref: '#/components/schemas/enterprise-webhooks' milestone: $ref: '#/components/schemas/milestone' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: description: >- Whether a squash merge commit can use the pull request title as default. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: description: >- Whether a squash merge commit can use the pull request title as default. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository webhook-pull-request-edited: title: pull_request edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the comment if the action was `edited`. type: object properties: base: type: object properties: ref: type: object properties: from: type: string required: - from sha: type: object properties: from: type: string required: - from required: - ref - sha body: type: object properties: from: description: The previous version of the body if the action was `edited`. type: string required: - from title: type: object properties: from: description: >- The previous version of the title if the action was `edited`. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: allOf: - $ref: '#/components/schemas/pull-request' - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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"). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: 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. type: boolean default: false example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - number - pull_request - repository webhook-pull-request-labeled: title: pull_request labeled event type: object properties: action: type: string enum: - labeled example: labeled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-locked: title: pull_request locked event type: object properties: action: type: string enum: - locked example: locked enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-milestoned: title: pull_request milestoned event type: object properties: action: type: string enum: - milestoned example: milestoned enterprise: $ref: '#/components/schemas/enterprise-webhooks' milestone: $ref: '#/components/schemas/milestone' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: description: >- Whether a squash merge commit can use the pull request title as default. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: description: >- Whether a squash merge commit can use the pull request title as default. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository webhook-pull-request-opened: title: pull_request opened event type: object properties: action: type: string enum: - opened example: opened enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: allOf: - $ref: '#/components/schemas/pull-request' - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: 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.** type: boolean default: false example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-ready-for-review: title: pull_request ready_for_review event type: object properties: action: type: string enum: - ready_for_review example: ready_for_review enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: allOf: - $ref: '#/components/schemas/pull-request' - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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"). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: 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.** type: boolean default: false example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-reopened: title: pull_request reopened event type: object properties: action: type: string enum: - reopened example: reopened enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: allOf: - $ref: '#/components/schemas/pull-request' - type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_update_branch: description: Whether to allow updating the pull request's branch. type: boolean delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged. type: boolean default: false merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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"). type: string enum: - PR_TITLE - MERGE_MESSAGE squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE use_squash_pr_title_as_default: 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.** type: boolean default: false example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-review-comment-created: title: pull_request_review_comment created event type: object properties: action: type: string enum: - created example: created comment: title: Pull Request Review Comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string format: date-time diff_hunk: description: The diff of the line that the comment refers to. type: string html_url: description: HTML URL for the pull request review comment. type: string format: uri id: description: The ID of the pull request review comment. type: integer in_reply_to_id: description: The comment ID to reply to. type: integer line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the pull request review comment. type: string original_commit_id: description: The SHA of the original commit to which the comment applies. type: string original_line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true original_position: description: >- The index of the original line in the diff to which the comment applies. type: integer original_start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true path: description: The relative path of the file to which the comment applies. type: string position: description: The line index in the diff to which the comment applies. type: integer nullable: true pull_request_review_id: description: The ID of the pull request review to which the comment belongs. type: integer nullable: true pull_request_url: description: URL for the pull request that the review comment belongs to. type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket side: description: >- The side of the first line of the range for a multi-line comment. type: string enum: - LEFT - RIGHT start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true start_side: description: >- The side of the first line of the range for a multi-line comment. type: string nullable: true enum: - LEFT - RIGHT - default: RIGHT subject_type: description: >- The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file updated_at: type: string format: date-time url: description: URL for the pull request review comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - pull_request_review_id - id - node_id - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links - start_line - original_start_line - original_line - line - start_side - side - reactions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - comment - pull_request - repository - sender webhook-pull-request-review-comment-deleted: title: pull_request_review_comment deleted event type: object properties: action: type: string enum: - deleted example: deleted comment: title: Pull Request Review Comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string format: date-time diff_hunk: description: The diff of the line that the comment refers to. type: string html_url: description: HTML URL for the pull request review comment. type: string format: uri id: description: The ID of the pull request review comment. type: integer in_reply_to_id: description: The comment ID to reply to. type: integer line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the pull request review comment. type: string original_commit_id: description: The SHA of the original commit to which the comment applies. type: string original_line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer original_position: description: >- The index of the original line in the diff to which the comment applies. type: integer original_start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true path: description: The relative path of the file to which the comment applies. type: string position: description: The line index in the diff to which the comment applies. type: integer nullable: true pull_request_review_id: description: The ID of the pull request review to which the comment belongs. type: integer nullable: true pull_request_url: description: URL for the pull request that the review comment belongs to. type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket side: description: >- The side of the first line of the range for a multi-line comment. type: string enum: - LEFT - RIGHT start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true start_side: description: >- The side of the first line of the range for a multi-line comment. type: string nullable: true enum: - LEFT - RIGHT - default: RIGHT subject_type: description: >- The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file updated_at: type: string format: date-time url: description: URL for the pull request review comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - pull_request_review_id - id - node_id - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links - start_line - original_start_line - original_line - line - start_side - side - reactions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - comment - pull_request - repository - sender webhook-pull-request-review-comment-edited: title: pull_request_review_comment edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the comment. type: object properties: body: type: object properties: from: description: The previous version of the body. type: string required: - from comment: title: Pull Request Review Comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string format: date-time diff_hunk: description: The diff of the line that the comment refers to. type: string html_url: description: HTML URL for the pull request review comment. type: string format: uri id: description: The ID of the pull request review comment. type: integer in_reply_to_id: description: The comment ID to reply to. type: integer line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the pull request review comment. type: string original_commit_id: description: The SHA of the original commit to which the comment applies. type: string original_line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer original_position: description: >- The index of the original line in the diff to which the comment applies. type: integer original_start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true path: description: The relative path of the file to which the comment applies. type: string position: description: The line index in the diff to which the comment applies. type: integer nullable: true pull_request_review_id: description: The ID of the pull request review to which the comment belongs. type: integer nullable: true pull_request_url: description: URL for the pull request that the review comment belongs to. type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket side: description: >- The side of the first line of the range for a multi-line comment. type: string enum: - LEFT - RIGHT start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true start_side: description: >- The side of the first line of the range for a multi-line comment. type: string nullable: true enum: - LEFT - RIGHT - default: RIGHT subject_type: description: >- The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file updated_at: type: string format: date-time url: description: URL for the pull request review comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - pull_request_review_id - id - node_id - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links - start_line - original_start_line - original_line - line - start_side - side - reactions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - comment - pull_request - repository - sender webhook-pull-request-review-dismissed: title: pull_request_review dismissed event type: object properties: action: type: string enum: - dismissed example: dismissed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Simple Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - draft - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' review: description: The review that was affected. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href required: - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the review. type: string nullable: true commit_id: description: A commit SHA for the review. type: string html_url: type: string format: uri id: description: Unique identifier of the review type: integer node_id: type: string pull_request_url: type: string format: uri state: type: string enum: - dismissed - approved - changes_requested submitted_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - id - node_id - user - body - commit_id - submitted_at - state - html_url - pull_request_url - author_association - _links sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - review - pull_request - repository - sender webhook-pull-request-review-edited: title: pull_request_review edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: body: type: object properties: from: description: The previous version of the body if the action was `edited`. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Simple Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - draft - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' review: description: The review that was affected. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href required: - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the review. type: string nullable: true commit_id: description: A commit SHA for the review. type: string html_url: type: string format: uri id: description: Unique identifier of the review type: integer node_id: type: string pull_request_url: type: string format: uri state: type: string submitted_at: type: string nullable: true format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - user - body - commit_id - submitted_at - state - html_url - pull_request_url - author_association - _links sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - review - pull_request - repository - sender webhook-pull-request-review-request-removed: title: pull_request review_request_removed event oneOf: - type: object properties: action: type: string enum: - review_request_removed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: description: The default value for a squash merge commit message. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_title: description: The default value for a squash merge commit title. type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' requested_reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sender: $ref: '#/components/schemas/simple-user-webhooks' required: - requested_reviewer - action - number - pull_request - repository - sender - type: object properties: action: type: string enum: - review_request_removed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' requested_team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission sender: $ref: '#/components/schemas/simple-user-webhooks' required: - requested_team - action - number - pull_request - repository - sender webhook-pull-request-review-requested: title: pull_request review_requested event oneOf: - type: object properties: action: type: string enum: - review_requested enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' requested_reviewer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id sender: $ref: '#/components/schemas/simple-user-webhooks' required: - requested_reviewer - action - number - pull_request - repository - sender - type: object properties: action: type: string enum: - review_requested enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' requested_team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id sender: $ref: '#/components/schemas/simple-user-webhooks' required: - requested_team - action - number - pull_request - repository - sender webhook-pull-request-review-submitted: title: pull_request_review submitted event type: object properties: action: type: string enum: - submitted example: submitted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Simple Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - draft - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' review: description: The review that was affected. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href required: - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the review. type: string nullable: true commit_id: description: A commit SHA for the review. type: string html_url: type: string format: uri id: description: Unique identifier of the review type: integer node_id: type: string pull_request_url: type: string format: uri state: type: string submitted_at: type: string nullable: true format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - id - node_id - user - body - commit_id - submitted_at - state - html_url - pull_request_url - author_association - _links sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - review - pull_request - repository - sender webhook-pull-request-review-thread-resolved: title: pull_request_review_thread resolved event type: object properties: action: type: string enum: - resolved example: resolved enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Simple Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - draft - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' thread: type: object properties: comments: type: array items: title: Pull Request Review Comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string format: date-time diff_hunk: description: The diff of the line that the comment refers to. type: string html_url: description: HTML URL for the pull request review comment. type: string format: uri id: description: The ID of the pull request review comment. type: integer in_reply_to_id: description: The comment ID to reply to. type: integer line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the pull request review comment. type: string original_commit_id: description: >- The SHA of the original commit to which the comment applies. type: string original_line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true original_position: description: >- The index of the original line in the diff to which the comment applies. type: integer original_start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true path: description: >- The relative path of the file to which the comment applies. type: string position: description: The line index in the diff to which the comment applies. type: integer nullable: true pull_request_review_id: description: >- The ID of the pull request review to which the comment belongs. type: integer nullable: true pull_request_url: description: >- URL for the pull request that the review comment belongs to. type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket side: description: >- The side of the first line of the range for a multi-line comment. type: string enum: - LEFT - RIGHT start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true start_side: description: >- The side of the first line of the range for a multi-line comment. type: string nullable: true enum: - LEFT - RIGHT - default: RIGHT subject_type: description: >- The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file updated_at: type: string format: date-time url: description: URL for the pull request review comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - pull_request_review_id - id - node_id - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links - start_line - original_start_line - original_line - line - start_side - side - reactions node_id: type: string required: - node_id - comments required: - action - thread - pull_request - repository webhook-pull-request-review-thread-unresolved: title: pull_request_review_thread unresolved event type: object properties: action: type: string enum: - unresolved example: unresolved enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Simple Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true closed_at: type: string nullable: true comments_url: type: string format: uri commits_url: type: string format: uri created_at: type: string diff_url: type: string format: uri draft: type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean merge_commit_sha: type: string nullable: true merged_at: type: string nullable: true milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: type: integer patch_url: type: string format: uri requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments_url: type: string format: uri state: type: string enum: - open - closed statuses_url: type: string format: uri title: type: string updated_at: type: string url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - draft - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' thread: type: object properties: comments: type: array items: title: Pull Request Review Comment description: >- The [comment](https://docs.github.com/enterprise-server@3.9/rest/pulls/comments#get-a-review-comment-for-a-pull-request) itself. type: object properties: _links: type: object properties: html: title: Link type: object properties: href: type: string format: uri-template required: - href pull_request: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - pull_request author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER body: description: The text of the comment. type: string commit_id: description: The SHA of the commit to which the comment applies. type: string created_at: type: string format: date-time diff_hunk: description: The diff of the line that the comment refers to. type: string html_url: description: HTML URL for the pull request review comment. type: string format: uri id: description: The ID of the pull request review comment. type: integer in_reply_to_id: description: The comment ID to reply to. type: integer line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer nullable: true node_id: description: The node ID of the pull request review comment. type: string original_commit_id: description: >- The SHA of the original commit to which the comment applies. type: string original_line: description: >- The line of the blob to which the comment applies. The last line of the range for a multi-line comment type: integer original_position: description: >- The index of the original line in the diff to which the comment applies. type: integer original_start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true path: description: >- The relative path of the file to which the comment applies. type: string position: description: The line index in the diff to which the comment applies. type: integer nullable: true pull_request_review_id: description: >- The ID of the pull request review to which the comment belongs. type: integer nullable: true pull_request_url: description: >- URL for the pull request that the review comment belongs to. type: string format: uri reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket side: description: >- The side of the first line of the range for a multi-line comment. type: string enum: - LEFT - RIGHT start_line: description: The first line of the range for a multi-line comment. type: integer nullable: true start_side: description: >- The side of the first line of the range for a multi-line comment. type: string nullable: true enum: - LEFT - RIGHT - default: RIGHT subject_type: description: >- The level at which the comment is targeted, can be a diff line or a file. type: string enum: - line - file updated_at: type: string format: date-time url: description: URL for the pull request review comment type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - pull_request_review_id - id - node_id - diff_hunk - path - position - original_position - commit_id - original_commit_id - user - body - created_at - updated_at - html_url - pull_request_url - author_association - _links - start_line - original_start_line - original_line - line - start_side - side - reactions node_id: type: string required: - node_id - comments required: - action - thread - pull_request - repository webhook-pull-request-synchronize: title: pull_request synchronize event type: object properties: action: type: string enum: - synchronize example: synchronize after: type: string example: example_value before: type: string example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: description: The default value for a merge commit message title. type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - before - after - pull_request - repository - sender webhook-pull-request-unassigned: title: pull_request unassigned event type: object properties: action: type: string enum: - unassigned example: unassigned assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository webhook-pull-request-unlabeled: title: pull_request unlabeled event type: object properties: action: type: string enum: - unlabeled example: unlabeled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' label: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string nullable: true enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string nullable: true ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: description: The default value for a merge commit message. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: description: The default value for a merge commit message title. type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization - Mannequin url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-pull-request-unlocked: title: pull_request unlocked event type: object properties: action: type: string enum: - unlocked example: unlocked enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' number: description: The pull request number. type: integer example: 42 organization: $ref: '#/components/schemas/organization-simple-webhooks' pull_request: title: Pull Request type: object properties: _links: type: object properties: comments: title: Link type: object properties: href: type: string format: uri-template required: - href commits: title: Link type: object properties: href: type: string format: uri-template required: - href html: title: Link type: object properties: href: type: string format: uri-template required: - href issue: title: Link type: object properties: href: type: string format: uri-template required: - href review_comment: title: Link type: object properties: href: type: string format: uri-template required: - href review_comments: title: Link type: object properties: href: type: string format: uri-template required: - href self: title: Link type: object properties: href: type: string format: uri-template required: - href statuses: title: Link type: object properties: href: type: string format: uri-template required: - href required: - self - html - issue - comments - review_comments - review_comment - commits - statuses active_lock_reason: type: string nullable: true enum: - resolved - off-topic - too heated - spam - additions: type: integer assignee: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id assignees: type: array items: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER auto_merge: title: PullRequestAutoMerge description: The status of auto merging a pull request. type: object nullable: true properties: commit_message: description: Commit message for the merge commit. type: string nullable: true commit_title: description: Title for the merge commit message. type: string enabled_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id merge_method: description: The merge method to use. type: string enum: - merge - squash - rebase required: - enabled_by - merge_method - commit_title - commit_message base: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo body: type: string nullable: true changed_files: type: integer closed_at: type: string nullable: true format: date-time comments: type: integer comments_url: type: string format: uri commits: type: integer commits_url: type: string format: uri created_at: type: string format: date-time deletions: type: integer diff_url: type: string format: uri draft: description: Indicates whether or not the pull request is a draft. type: boolean head: type: object properties: label: type: string ref: type: string repo: title: Repository description: A git repository type: object nullable: true properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: >- Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merge_commit_message: 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. type: string enum: - PR_BODY - PR_TITLE - BLANK merge_commit_title: 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). type: string enum: - PR_TITLE - MERGE_MESSAGE merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer squash_merge_commit_message: 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. type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK squash_merge_commit_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). type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri use_squash_pr_title_as_default: 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. type: boolean default: false visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: >- Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sha: type: string user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - label - ref - sha - user - repo html_url: type: string format: uri id: type: integer issue_url: type: string format: uri labels: type: array items: title: Label type: object properties: color: description: >- 6-character hex code, without the leading #, identifying the color type: string default: type: boolean description: type: string nullable: true id: type: integer name: description: The name of the label. type: string node_id: type: string url: description: URL for the label type: string format: uri required: - id - node_id - url - name - color - default - description locked: type: boolean maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. type: boolean merge_commit_sha: type: string nullable: true mergeable: type: boolean nullable: true mergeable_state: type: string merged: type: boolean nullable: true merged_at: type: string nullable: true format: date-time merged_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id milestone: title: Milestone description: A collection of related issues and pull requests. type: object nullable: true properties: closed_at: type: string nullable: true format: date-time closed_issues: type: integer created_at: type: string format: date-time creator: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id description: type: string nullable: true due_on: type: string nullable: true format: date-time html_url: type: string format: uri id: type: integer labels_url: type: string format: uri node_id: type: string number: description: The number of the milestone. type: integer open_issues: type: integer state: description: The state of the milestone. type: string enum: - open - closed title: description: The title of the milestone. type: string updated_at: type: string format: date-time url: type: string format: uri required: - url - html_url - labels_url - id - node_id - number - title - description - creator - open_issues - closed_issues - state - created_at - updated_at - due_on - closed_at node_id: type: string number: description: >- Number uniquely identifying the pull request within its repository. type: integer patch_url: type: string format: uri rebaseable: type: boolean nullable: true requested_reviewers: type: array items: oneOf: - title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id - title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id requested_teams: type: array items: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: >- Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id review_comment_url: type: string format: uri-template review_comments: type: integer review_comments_url: type: string format: uri state: description: State of this Pull Request. Either `open` or `closed`. type: string enum: - open - closed statuses_url: type: string format: uri title: description: The title of the pull request. type: string updated_at: type: string format: date-time url: type: string format: uri user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - url - id - node_id - html_url - diff_url - patch_url - issue_url - number - state - locked - title - user - body - created_at - updated_at - closed_at - merged_at - merge_commit_sha - assignee - assignees - requested_reviewers - requested_teams - labels - milestone - commits_url - review_comments_url - review_comment_url - comments_url - statuses_url - head - base - _links - author_association - auto_merge - active_lock_reason - draft repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - number - pull_request - repository - sender webhook-push: title: push event type: object properties: after: description: The SHA of the most recent commit on `ref` after the push. type: string example: example_value base_ref: type: string nullable: true example: main before: description: The SHA of the most recent commit on `ref` before the push. type: string example: example_value commits: description: >- An array of commit objects describing the pushed commits. (Pushed commits are all commits that are included in the `compare` between the `before` commit and the `after` commit.) The array includes a maximum of 2048 commits. If necessary, you can use the [Commits API](https://docs.github.com/enterprise-server@3.9/rest/commits) to fetch additional commits. type: array items: title: Commit type: object properties: added: description: >- An array of files added in the commit. A maximum of 3000 changed files will be reported per commit. type: array items: type: string author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name distinct: description: >- Whether this commit is distinct from any that have been pushed before. type: boolean id: type: string message: description: The commit message. type: string modified: description: >- An array of files modified by the commit. A maximum of 3000 changed files will be reported per commit. type: array items: type: string removed: description: >- An array of files removed in the commit. A maximum of 3000 changed files will be reported per commit. type: array items: type: string timestamp: description: The ISO 8601 timestamp of the commit. type: string format: date-time tree_id: type: string url: description: URL that points to the commit API resource. type: string format: uri required: - id - tree_id - distinct - message - timestamp - url - author - committer compare: description: >- URL that shows the changes in this `ref` update, from the `before` commit to the `after` commit. For a newly created `ref` that is directly based on the default branch, this is the comparison between the head of the default branch and the `after` commit. Otherwise, this shows all commits until the `after` commit. type: string example: example_value created: description: Whether this push created the `ref`. type: boolean example: true deleted: description: Whether this push deleted the `ref`. type: boolean example: true enterprise: $ref: '#/components/schemas/enterprise-webhooks' forced: description: Whether this push was a force push of the `ref`. type: boolean example: true head_commit: title: Commit type: object nullable: true properties: added: description: An array of files added in the commit. type: array items: type: string author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name distinct: description: >- Whether this commit is distinct from any that have been pushed before. type: boolean id: type: string message: description: The commit message. type: string modified: description: An array of files modified by the commit. type: array items: type: string removed: description: An array of files removed in the commit. type: array items: type: string timestamp: description: The ISO 8601 timestamp of the commit. type: string format: date-time tree_id: type: string url: description: URL that points to the commit API resource. type: string format: uri required: - id - tree_id - distinct - message - timestamp - url - author - committer installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' pusher: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - name ref: description: >- The full git ref that was pushed. Example: `refs/heads/main` or `refs/tags/v3.14.1`. type: string example: main repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true has_discussions: description: Whether discussions are enabled. type: boolean default: false homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits type: boolean required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - has_discussions - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sender: $ref: '#/components/schemas/simple-user-webhooks' required: - ref - before - after - created - deleted - forced - base_ref - compare - commits - head_commit - repository - pusher webhook-registry-package-published: type: object properties: action: type: string enum: - published example: published enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' registry_package: type: object properties: created_at: type: string nullable: true description: type: string nullable: true ecosystem: type: string html_url: type: string id: type: integer name: type: string namespace: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - login - id - node_id - avatar_url - gravatar_id - url - html_url - followers_url - following_url - gists_url - starred_url - subscriptions_url - organizations_url - repos_url - events_url - received_events_url - type - site_admin package_type: type: string package_version: type: object nullable: true properties: author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - login - id - node_id - avatar_url - gravatar_id - url - html_url - followers_url - following_url - gists_url - starred_url - subscriptions_url - organizations_url - repos_url - events_url - received_events_url - type - site_admin body: oneOf: - type: string - type: object body_html: type: string container_metadata: type: object properties: labels: type: object nullable: true manifest: type: object nullable: true tag: type: object properties: digest: type: string name: type: string created_at: type: string description: type: string docker_metadata: type: array items: type: object properties: tags: type: array items: type: string draft: type: boolean html_url: type: string id: type: integer installation_command: type: string manifest: type: string metadata: type: array items: type: object additionalProperties: true name: type: string npm_metadata: type: object nullable: true properties: name: type: string version: type: string npm_user: type: string author: oneOf: - type: string - type: object nullable: true bugs: oneOf: - type: string - type: object nullable: true dependencies: type: object dev_dependencies: type: object peer_dependencies: type: object optional_dependencies: type: object description: type: string dist: oneOf: - type: string - type: object nullable: true git_head: type: string homepage: type: string license: type: string main: type: string repository: oneOf: - type: string - type: object nullable: true scripts: type: object id: type: string node_version: type: string npm_version: type: string has_shrinkwrap: type: boolean maintainers: type: array items: type: string contributors: type: array items: type: string engines: type: object keywords: type: array items: type: string files: type: array items: type: string bin: type: object man: type: object directories: oneOf: - type: string - type: object nullable: true os: type: array items: type: string cpu: type: array items: type: string readme: type: string installation_command: type: string release_id: type: integer commit_oid: type: string published_via_actions: type: boolean deleted_by_id: type: integer nuget_metadata: type: array nullable: true items: type: object properties: id: oneOf: - type: string - type: object - type: integer nullable: true name: type: string value: oneOf: - type: boolean - type: string - type: integer - type: object properties: url: type: string branch: type: string commit: type: string type: type: string package_files: type: array items: type: object properties: content_type: type: string created_at: type: string download_url: type: string id: type: integer md5: type: string nullable: true name: type: string sha1: type: string nullable: true sha256: type: string nullable: true size: type: integer state: type: string nullable: true updated_at: type: string required: - download_url - id - name - sha256 - sha1 - md5 - content_type - state - size - created_at - updated_at package_url: type: string prerelease: type: boolean release: type: object properties: author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string created_at: type: string draft: type: boolean html_url: type: string id: type: integer name: type: string nullable: true prerelease: type: boolean published_at: type: string tag_name: type: string target_commitish: type: string url: type: string rubygems_metadata: type: array items: $ref: '#/components/schemas/webhook-rubygems-metadata' summary: type: string tag_name: type: string target_commitish: type: string target_oid: type: string updated_at: type: string version: type: string required: - id - version - name - description - summary - html_url - metadata - package_files - installation_command - package_url registry: type: object nullable: true properties: about_url: type: string name: type: string type: type: string url: type: string vendor: type: string updated_at: type: string nullable: true required: - id - name - namespace - description - ecosystem - package_type - html_url - created_at - updated_at - owner - package_version - registry repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - registry_package - sender webhook-registry-package-updated: type: object properties: action: type: string enum: - updated example: updated enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' registry_package: type: object properties: created_at: type: string description: nullable: true ecosystem: type: string html_url: type: string id: type: integer name: type: string namespace: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - login - id - node_id - avatar_url - gravatar_id - url - html_url - followers_url - following_url - gists_url - starred_url - subscriptions_url - organizations_url - repos_url - events_url - received_events_url - type - site_admin package_type: type: string package_version: type: object properties: author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - login - id - node_id - avatar_url - gravatar_id - url - html_url - followers_url - following_url - gists_url - starred_url - subscriptions_url - organizations_url - repos_url - events_url - received_events_url - type - site_admin body: type: string body_html: type: string created_at: type: string description: type: string docker_metadata: type: array items: type: object nullable: true properties: tags: type: array items: type: string draft: type: boolean html_url: type: string id: type: integer installation_command: type: string manifest: type: string metadata: type: array items: type: object additionalProperties: true name: type: string package_files: type: array items: type: object properties: content_type: type: string created_at: type: string download_url: type: string id: type: integer md5: type: string nullable: true name: type: string sha1: type: string nullable: true sha256: type: string size: type: integer state: type: string updated_at: type: string package_url: type: string prerelease: type: boolean release: type: object properties: author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string required: - login - id - node_id - avatar_url - gravatar_id - url - html_url - followers_url - following_url - gists_url - starred_url - subscriptions_url - organizations_url - repos_url - events_url - received_events_url - type - site_admin created_at: type: string draft: type: boolean html_url: type: string id: type: integer name: type: string prerelease: type: boolean published_at: type: string tag_name: type: string target_commitish: type: string url: type: string required: - url - html_url - id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at rubygems_metadata: type: array items: $ref: '#/components/schemas/webhook-rubygems-metadata' summary: type: string tag_name: type: string target_commitish: type: string target_oid: type: string updated_at: type: string version: type: string required: - id - version - name - description - summary - body - body_html - html_url - target_commitish - target_oid - created_at - updated_at - metadata - package_files - author - installation_command - package_url registry: type: object nullable: true updated_at: type: string required: - id - name - namespace - description - ecosystem - package_type - html_url - created_at - updated_at - owner - package_version - registry repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - registry_package - sender webhook-release-created: title: release created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - release - repository - sender webhook-release-deleted: title: release deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - release - repository - sender webhook-release-edited: title: release edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: body: type: object properties: from: description: The previous version of the body if the action was `edited`. type: string required: - from name: type: object properties: from: description: The previous version of the name if the action was `edited`. type: string required: - from make_latest: type: object properties: to: description: >- Whether this release was explicitly `edited` to be the latest. type: boolean required: - to enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - release - repository webhook-release-prereleased: title: release prereleased event type: object properties: action: type: string enum: - prereleased example: prereleased enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: allOf: - title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body - type: object properties: assets: type: array items: type: object nullable: true assets_url: type: string author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string body: type: string nullable: true created_at: type: string draft: type: boolean html_url: type: string id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean enum: - true published_at: type: string nullable: true tag_name: type: string tarball_url: type: string nullable: true target_commitish: type: string upload_url: type: string url: type: string zipball_url: type: string nullable: true required: - prerelease example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - release - repository webhook-release-published: title: release published event type: object properties: action: type: string enum: - published example: published enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: allOf: - title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body - type: object properties: assets: type: array items: type: object nullable: true assets_url: type: string author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string body: type: string nullable: true created_at: type: string draft: type: boolean html_url: type: string id: type: integer name: type: string nullable: true node_id: type: string prerelease: type: boolean published_at: type: string nullable: true format: date-time tag_name: type: string tarball_url: type: string nullable: true target_commitish: type: string upload_url: type: string url: type: string zipball_url: type: string nullable: true required: - published_at example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - release - repository webhook-release-released: title: release released event type: object properties: action: type: string enum: - released example: released enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - release - repository webhook-release-unpublished: title: release unpublished event type: object properties: action: type: string enum: - unpublished example: unpublished enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' release: allOf: - title: Release description: >- The [release](https://docs.github.com/enterprise-server@3.9/rest/releases/releases/#get-a-release) object. type: object properties: assets: type: array items: title: Release Asset description: Data related to a release. type: object properties: browser_download_url: type: string format: uri content_type: type: string created_at: type: string format: date-time download_count: type: integer id: type: integer label: type: string nullable: true name: description: The file name of the asset. type: string node_id: type: string size: type: integer state: description: State of the release asset. type: string enum: - uploaded updated_at: type: string format: date-time uploader: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id url: type: string format: uri required: - url - browser_download_url - id - node_id - name - label - state - content_type - size - download_count - created_at - updated_at assets_url: type: string format: uri author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id body: type: string nullable: true created_at: type: string nullable: true format: date-time discussion_url: type: string format: uri draft: description: Whether the release is a draft or published type: boolean html_url: type: string format: uri id: type: integer name: type: string nullable: true node_id: type: string prerelease: description: >- Whether the release is identified as a prerelease or a full release. type: boolean published_at: type: string nullable: true format: date-time reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket tag_name: description: The name of the tag. type: string tarball_url: type: string nullable: true format: uri target_commitish: description: >- Specifies the commitish value that determines where the Git tag is created from. type: string upload_url: type: string format: uri-template url: type: string format: uri zipball_url: type: string nullable: true format: uri required: - url - assets_url - upload_url - html_url - id - node_id - tag_name - target_commitish - name - draft - author - prerelease - created_at - published_at - assets - tarball_url - zipball_url - body - type: object properties: assets: type: array items: type: object nullable: true assets_url: type: string author: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string body: type: string nullable: true created_at: type: string draft: type: boolean html_url: type: string id: type: integer name: type: string nullable: true node_id: type: string prerelease: type: boolean published_at: type: string nullable: true tag_name: type: string tarball_url: type: string nullable: true target_commitish: type: string upload_url: type: string url: type: string zipball_url: type: string nullable: true required: - published_at example: example_value repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - release - repository webhook-repository-anonymous-access-disabled: type: object properties: action: type: string enum: - anonymous_access_disabled example: anonymous_access_disabled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action webhook-repository-anonymous-access-enabled: type: object properties: action: type: string enum: - anonymous_access_enabled example: anonymous_access_enabled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action webhook-repository-archived: title: repository archived event type: object properties: action: type: string enum: - archived example: archived enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-repository-created: title: repository created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-repository-deleted: title: repository deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-repository-dispatch-sample: title: repository_dispatch event type: object properties: action: type: string enum: - sample.collected example: sample.collected branch: type: string example: main client_payload: type: object nullable: true additionalProperties: true enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - branch - client_payload - repository - sender - installation webhook-repository-edited: title: repository edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: default_branch: type: object properties: from: type: string required: - from description: type: object properties: from: type: string nullable: true required: - from homepage: type: object properties: from: type: string nullable: true required: - from topics: type: object properties: from: type: array nullable: true items: type: string enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - repository - sender webhook-repository-privatized: title: repository privatized event type: object properties: action: type: string enum: - privatized example: privatized enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-repository-publicized: title: repository publicized event type: object properties: action: type: string enum: - publicized example: publicized enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-repository-renamed: title: repository renamed event type: object properties: action: type: string enum: - renamed example: renamed changes: type: object properties: repository: type: object properties: name: type: object properties: from: type: string required: - from required: - name required: - repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - repository - sender webhook-repository-transferred: title: repository transferred event type: object properties: action: type: string enum: - transferred example: transferred changes: type: object properties: owner: type: object properties: from: type: object properties: organization: title: Organization type: object properties: avatar_url: type: string format: uri description: type: string nullable: true events_url: type: string format: uri hooks_url: type: string format: uri html_url: type: string format: uri id: type: integer issues_url: type: string format: uri login: type: string members_url: type: string format: uri-template node_id: type: string public_members_url: type: string format: uri-template repos_url: type: string format: uri url: type: string format: uri required: - login - id - node_id - url - repos_url - events_url - hooks_url - issues_url - members_url - public_members_url - avatar_url - description user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - from required: - owner enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - changes - repository - sender webhook-repository-unarchived: title: repository unarchived event type: object properties: action: type: string enum: - unarchived example: unarchived enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-repository-vulnerability-alert-create: title: repository_vulnerability_alert create event type: object properties: action: type: string enum: - create example: create alert: allOf: - title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string dismiss_reason: type: string dismissed_at: type: string dismisser: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id external_identifier: type: string external_reference: type: string nullable: true format: uri fix_reason: type: string fixed_at: type: string format: date-time fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open - dismissed - fixed required: - id - number - node_id - state - affected_range - affected_package_name - ghsa_id - severity - external_reference - external_identifier - created_at - type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string external_identifier: type: string external_reference: type: string nullable: true fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open required: - state example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-repository-vulnerability-alert-dismiss: title: repository_vulnerability_alert dismiss event type: object properties: action: type: string enum: - dismiss example: dismiss alert: allOf: - title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string dismiss_comment: type: string nullable: true dismiss_reason: type: string dismissed_at: type: string dismisser: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id external_identifier: type: string external_reference: type: string nullable: true format: uri fix_reason: type: string fixed_at: type: string format: date-time fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open - dismissed - fixed required: - id - number - node_id - state - affected_range - affected_package_name - ghsa_id - severity - external_reference - external_identifier - created_at - type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string dismiss_comment: type: string nullable: true dismiss_reason: type: string dismissed_at: type: string dismisser: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id external_identifier: type: string external_reference: type: string nullable: true fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - dismissed required: - dismisser - dismiss_reason - dismissed_at - state example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-repository-vulnerability-alert-reopen: title: repository_vulnerability_alert reopen event type: object properties: action: type: string enum: - reopen example: reopen alert: allOf: - title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string dismiss_reason: type: string dismissed_at: type: string dismisser: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id external_identifier: type: string external_reference: type: string nullable: true format: uri fix_reason: type: string fixed_at: type: string format: date-time fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open - dismissed - fixed required: - id - number - node_id - state - affected_range - affected_package_name - ghsa_id - severity - external_reference - external_identifier - created_at - type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string external_identifier: type: string external_reference: type: string nullable: true fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open required: - state example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-repository-vulnerability-alert-resolve: title: repository_vulnerability_alert resolve event type: object properties: action: type: string enum: - resolve example: resolve alert: allOf: - title: Repository Vulnerability Alert Alert description: The security alert of the vulnerable dependency. type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string dismiss_reason: type: string dismissed_at: type: string dismisser: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id external_identifier: type: string external_reference: type: string nullable: true format: uri fix_reason: type: string fixed_at: type: string format: date-time fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - open - dismissed - fixed required: - id - number - node_id - state - affected_range - affected_package_name - ghsa_id - severity - external_reference - external_identifier - created_at - type: object properties: affected_package_name: type: string affected_range: type: string created_at: type: string external_identifier: type: string external_reference: type: string nullable: true fix_reason: type: string fixed_at: type: string format: date-time fixed_in: type: string ghsa_id: type: string id: type: integer node_id: type: string number: type: integer severity: type: string state: type: string enum: - fixed - open required: - state example: example_value enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository - sender webhook-secret-scanning-alert-created: title: secret_scanning_alert created event type: object properties: action: type: string enum: - created example: created alert: $ref: '#/components/schemas/secret-scanning-alert-webhook' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository webhook-secret-scanning-alert-location-created: title: Secret Scanning Alert Location Created Event type: object properties: action: type: string enum: - created example: created alert: $ref: '#/components/schemas/secret-scanning-alert-webhook' installation: $ref: '#/components/schemas/simple-installation' location: $ref: '#/components/schemas/secret-scanning-location' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - location - alert - repository - sender webhook-secret-scanning-alert-location-created-form-encoded: title: Secret Scanning Alert Location Created Event type: object properties: payload: description: >- A URL-encoded string of the secret_scanning_alert_location.created JSON payload. The decoded payload is a JSON object. type: string example: example_value required: - payload webhook-secret-scanning-alert-reopened: title: secret_scanning_alert reopened event type: object properties: action: type: string enum: - reopened example: reopened alert: $ref: '#/components/schemas/secret-scanning-alert-webhook' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository webhook-secret-scanning-alert-resolved: title: secret_scanning_alert resolved event type: object properties: action: type: string enum: - resolved example: resolved alert: $ref: '#/components/schemas/secret-scanning-alert-webhook' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository webhook-secret-scanning-alert-revoked: title: secret_scanning_alert revoked event type: object properties: action: type: string enum: - revoked example: revoked alert: $ref: '#/components/schemas/secret-scanning-alert-webhook' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - alert - repository webhook-security-advisory-published: title: security_advisory published event type: object properties: action: type: string enum: - published example: published enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' security_advisory: description: >- The details of the security advisory, including summary, description, and severity. type: object properties: cvss: type: object properties: score: type: number vector_string: type: string nullable: true required: - vector_string - score cwes: type: array items: type: object properties: cwe_id: type: string name: type: string required: - cwe_id - name description: type: string ghsa_id: type: string identifiers: type: array items: type: object properties: type: type: string value: type: string required: - value - type published_at: type: string references: type: array items: type: object properties: url: type: string format: uri required: - url severity: type: string summary: type: string updated_at: type: string vulnerabilities: type: array items: type: object properties: first_patched_version: type: object nullable: true properties: identifier: type: string required: - identifier package: type: object properties: ecosystem: type: string name: type: string required: - ecosystem - name severity: type: string vulnerable_version_range: type: string required: - package - severity - vulnerable_version_range - first_patched_version withdrawn_at: type: string nullable: true required: - cvss - cwes - ghsa_id - summary - description - severity - identifiers - references - published_at - updated_at - withdrawn_at - vulnerabilities sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - security_advisory webhook-security-advisory-updated: title: security_advisory updated event type: object properties: action: type: string enum: - updated example: updated enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' security_advisory: description: >- The details of the security advisory, including summary, description, and severity. type: object properties: cvss: type: object properties: score: type: number vector_string: type: string nullable: true required: - vector_string - score cwes: type: array items: type: object properties: cwe_id: type: string name: type: string required: - cwe_id - name description: type: string ghsa_id: type: string identifiers: type: array items: type: object properties: type: type: string value: type: string required: - value - type published_at: type: string references: type: array items: type: object properties: url: type: string format: uri required: - url severity: type: string summary: type: string updated_at: type: string vulnerabilities: type: array items: type: object properties: first_patched_version: type: object nullable: true properties: identifier: type: string required: - identifier package: type: object properties: ecosystem: type: string name: type: string required: - ecosystem - name severity: type: string vulnerable_version_range: type: string required: - package - severity - vulnerable_version_range - first_patched_version withdrawn_at: type: string nullable: true required: - cvss - cwes - ghsa_id - summary - description - severity - identifiers - references - published_at - updated_at - withdrawn_at - vulnerabilities sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - security_advisory webhook-security-advisory-withdrawn: title: security_advisory withdrawn event type: object properties: action: type: string enum: - withdrawn example: withdrawn enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' security_advisory: description: >- The details of the security advisory, including summary, description, and severity. type: object properties: cvss: type: object properties: score: type: number vector_string: type: string nullable: true required: - vector_string - score cwes: type: array items: type: object properties: cwe_id: type: string name: type: string required: - cwe_id - name description: type: string ghsa_id: type: string identifiers: type: array items: type: object properties: type: type: string value: type: string required: - value - type published_at: type: string references: type: array items: type: object properties: url: type: string format: uri required: - url severity: type: string summary: type: string updated_at: type: string vulnerabilities: type: array items: type: object properties: first_patched_version: type: object nullable: true properties: identifier: type: string required: - identifier package: type: object properties: ecosystem: type: string name: type: string required: - ecosystem - name severity: type: string vulnerable_version_range: type: string required: - package - severity - vulnerable_version_range - first_patched_version withdrawn_at: type: string required: - cvss - cwes - ghsa_id - summary - description - severity - identifiers - references - published_at - updated_at - withdrawn_at - vulnerabilities sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - security_advisory webhook-security-and-analysis: title: security_and_analysis event type: object properties: changes: type: object properties: from: type: object properties: security_and_analysis: $ref: '#/components/schemas/security-and-analysis' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/full-repository' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - changes - repository webhook-sponsorship-cancelled: title: sponsorship cancelled event type: object properties: action: type: string enum: - cancelled example: cancelled enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id tier: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier required: - action - sponsorship - sender webhook-sponsorship-created: title: sponsorship created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id tier: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier required: - action - sponsorship - sender webhook-sponsorship-edited: title: sponsorship edited event type: object properties: action: type: string enum: - edited example: edited changes: type: object properties: privacy_level: type: object properties: from: description: >- The `edited` event types include the details about the change when someone edits a sponsorship to change the privacy. type: string required: - from enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id tier: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier required: - action - changes - sponsorship - sender webhook-sponsorship-pending-cancellation: title: sponsorship pending_cancellation event type: object properties: action: type: string enum: - pending_cancellation example: pending_cancellation effective_date: description: >- The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string example: '2026-04-17T12:00:00Z' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id tier: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier required: - action - sponsorship - sender webhook-sponsorship-pending-tier-change: title: sponsorship pending_tier_change event type: object properties: action: type: string enum: - pending_tier_change example: pending_tier_change changes: type: object properties: tier: type: object properties: from: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - from required: - tier effective_date: description: >- The `pending_cancellation` and `pending_tier_change` event types will include the date the cancellation or tier change will take effect. type: string example: '2026-04-17T12:00:00Z' enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id tier: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier required: - action - changes - sponsorship - sender webhook-sponsorship-tier-changed: title: sponsorship tier_changed event type: object properties: action: type: string enum: - tier_changed example: tier_changed changes: type: object properties: tier: type: object properties: from: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - from required: - tier enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sponsorship: type: object properties: created_at: type: string maintainer: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string node_id: type: string privacy_level: type: string sponsor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id sponsorable: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id tier: title: Sponsorship Tier description: >- The `tier_changed` and `pending_tier_change` will include the original tier before the change or pending change. For more information, see the pending tier change payload. type: object properties: created_at: type: string description: type: string is_custom_ammount: type: boolean is_custom_amount: type: boolean is_one_time: type: boolean monthly_price_in_cents: type: integer monthly_price_in_dollars: type: integer name: type: string node_id: type: string required: - node_id - created_at - description - monthly_price_in_cents - monthly_price_in_dollars - name - is_one_time required: - node_id - created_at - sponsorable - sponsor - privacy_level - tier required: - action - changes - sponsorship - sender webhook-star-created: title: star created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' starred_at: description: >- The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. type: string nullable: true example: '2026-04-17T12:00:00Z' required: - action - starred_at - repository - sender webhook-star-deleted: title: star deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' starred_at: description: >- The time the star was created. This is a timestamp in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. Will be `null` for the `deleted` action. nullable: true example: '2026-04-17T12:00:00Z' required: - action - starred_at - repository - sender webhook-status: title: status event type: object properties: avatar_url: type: string nullable: true format: uri example: https://api.github.com/repos/octocat/Hello-World branches: description: >- An array of branch objects containing the status' SHA. Each branch contains the given SHA, but the SHA may or may not be the head of the branch. The array includes a maximum of 10 branches. type: array items: type: object properties: commit: type: object properties: sha: type: string nullable: true url: type: string nullable: true format: uri required: - sha - url name: type: string protected: type: boolean required: - name - commit - protected commit: type: object properties: author: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri comments_url: type: string format: uri commit: type: object properties: author: allOf: - title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name - type: object properties: date: type: string email: type: string name: type: string required: - date comment_count: type: integer committer: allOf: - title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name - type: object properties: date: type: string email: type: string name: type: string required: - date message: type: string tree: type: object properties: sha: type: string url: type: string format: uri required: - sha - url url: type: string format: uri verification: type: object properties: payload: type: string nullable: true reason: type: string enum: - expired_key - not_signing_key - gpgverify_error - gpgverify_unavailable - unsigned - unknown_signature_type - no_user - unverified_email - bad_email - unknown_key - malformed_signature - invalid - valid - bad_cert - ocsp_pending signature: type: string nullable: true verified: type: boolean required: - verified - reason - signature - payload required: - author - committer - message - tree - url - comment_count - verification committer: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri html_url: type: string format: uri node_id: type: string parents: type: array items: type: object properties: html_url: type: string format: uri sha: type: string url: type: string format: uri required: - sha - url - html_url sha: type: string url: type: string format: uri required: - sha - node_id - commit - url - html_url - comments_url - author - committer - parents context: type: string example: example_value created_at: type: string example: '2026-04-17T12:00:00Z' description: description: The optional human-readable description added to the status. type: string nullable: true example: This is an example repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' id: description: The unique identifier of the status. type: integer example: 42 installation: $ref: '#/components/schemas/simple-installation' name: type: string example: octocat organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' sha: description: The Commit SHA. type: string example: abc123def456789012345678901234567890 state: description: The new state. Can be `pending`, `success`, `failure`, or `error`. type: string enum: - pending - success - failure - error example: pending target_url: description: The optional link added to the status. type: string nullable: true example: https://api.github.com/repos/octocat/Hello-World updated_at: type: string example: '2026-04-17T12:00:00Z' required: - id - sha - name - target_url - context - description - state - commit - branches - created_at - updated_at - repository - sender webhook-team-add: title: team_add event type: object properties: enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - team - repository - sender webhook-team-added-to-repository: title: team added_to_repository event type: object properties: action: type: string enum: - added_to_repository example: added_to_repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sender: $ref: '#/components/schemas/simple-user-webhooks' team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - team - organization webhook-team-created: title: team created event type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sender: $ref: '#/components/schemas/simple-user-webhooks' team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - team - organization - sender webhook-team-deleted: title: team deleted event type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sender: $ref: '#/components/schemas/simple-user-webhooks' team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - team - organization webhook-team-edited: title: team edited event type: object properties: action: type: string enum: - edited example: edited changes: description: The changes to the team if the action was `edited`. type: object properties: description: type: object properties: from: description: >- The previous version of the description if the action was `edited`. type: string required: - from name: type: object properties: from: description: The previous version of the name if the action was `edited`. type: string required: - from privacy: type: object properties: from: description: >- The previous version of the team's privacy if the action was `edited`. type: string required: - from repository: type: object properties: permissions: type: object properties: from: type: object properties: admin: description: >- The previous version of the team member's `admin` permission on a repository, if the action was `edited`. type: boolean pull: description: >- The previous version of the team member's `pull` permission on a repository, if the action was `edited`. type: boolean push: description: >- The previous version of the team member's `push` permission on a repository, if the action was `edited`. type: boolean required: - from required: - permissions enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sender: $ref: '#/components/schemas/simple-user-webhooks' team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - changes - team - organization - sender webhook-team-removed-from-repository: title: team removed_from_repository event type: object properties: action: type: string enum: - removed_from_repository example: removed_from_repository enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: title: Repository description: A git repository type: object properties: allow_auto_merge: description: Whether to allow auto-merge for pull requests. type: boolean default: false allow_forking: description: Whether to allow private forks type: boolean allow_merge_commit: description: Whether to allow merge commits for pull requests. type: boolean default: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. type: boolean default: true allow_squash_merge: description: Whether to allow squash merges for pull requests. type: boolean default: true allow_update_branch: type: boolean archive_url: type: string format: uri-template archived: description: Whether the repository is archived. type: boolean default: false assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template clone_url: type: string format: uri collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri created_at: oneOf: - type: integer - type: string format: date-time default_branch: description: The default branch of the repository. type: string delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged type: boolean default: false deployments_url: type: string format: uri description: type: string nullable: true disabled: description: Returns whether or not this repository is disabled. type: boolean downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks: type: integer forks_count: type: integer forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template git_url: type: string format: uri has_downloads: description: Whether downloads are enabled. type: boolean default: true has_issues: description: Whether issues are enabled. type: boolean default: true has_pages: type: boolean has_projects: description: Whether projects are enabled. type: boolean default: true has_wiki: description: Whether the wiki is enabled. type: boolean default: true homepage: type: string nullable: true hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer is_template: type: boolean issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template language: type: string nullable: true languages_url: type: string format: uri license: title: License type: object nullable: true properties: key: type: string name: type: string node_id: type: string spdx_id: type: string url: type: string nullable: true format: uri required: - key - name - spdx_id - url - node_id master_branch: type: string merges_url: type: string format: uri milestones_url: type: string format: uri-template mirror_url: type: string nullable: true format: uri name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template open_issues: type: integer open_issues_count: type: integer organization: type: string owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id permissions: type: object properties: admin: type: boolean maintain: type: boolean pull: type: boolean push: type: boolean triage: type: boolean required: - pull - push - admin private: description: Whether the repository is private or public. type: boolean public: type: boolean pulls_url: type: string format: uri-template pushed_at: nullable: true oneOf: - type: integer - type: string format: date-time releases_url: type: string format: uri-template role_name: type: string nullable: true size: type: integer ssh_url: type: string stargazers: type: integer stargazers_count: type: integer stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri svn_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri topics: type: array items: type: string trees_url: type: string format: uri-template updated_at: type: string format: date-time url: type: string format: uri visibility: type: string enum: - public - private - internal watchers: type: integer watchers_count: type: integer required: - id - node_id - name - full_name - private - owner - html_url - description - fork - url - forks_url - keys_url - collaborators_url - teams_url - hooks_url - issue_events_url - events_url - assignees_url - branches_url - tags_url - blobs_url - git_tags_url - git_refs_url - trees_url - statuses_url - languages_url - stargazers_url - contributors_url - subscribers_url - subscription_url - commits_url - git_commits_url - comments_url - issue_comment_url - contents_url - compare_url - merges_url - archive_url - downloads_url - issues_url - pulls_url - milestones_url - notifications_url - labels_url - releases_url - deployments_url - created_at - updated_at - pushed_at - git_url - ssh_url - clone_url - svn_url - homepage - size - stargazers_count - watchers_count - language - has_issues - has_projects - has_downloads - has_wiki - has_pages - forks_count - mirror_url - archived - open_issues_count - license - forks - open_issues - watchers - default_branch - topics - visibility sender: $ref: '#/components/schemas/simple-user-webhooks' team: title: Team description: >- Groups of organization members that gives permissions on specified repositories. type: object properties: deleted: type: boolean description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string parent: type: object nullable: true properties: description: description: Description of the team type: string nullable: true html_url: type: string format: uri id: description: Unique identifier of the team type: integer members_url: type: string format: uri-template name: description: Name of the team type: string node_id: type: string permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id - node_id - slug - description - privacy - url - html_url - members_url - repositories_url - permission permission: description: Permission that the team will have for its repositories type: string privacy: type: string enum: - open - closed - secret repositories_url: type: string format: uri slug: type: string url: description: URL for the team type: string format: uri required: - name - id required: - action - team - organization - sender webhook-user-created: type: object properties: action: type: string enum: - created example: created enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - action webhook-user-deleted: type: object properties: action: type: string enum: - deleted example: deleted enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - action webhook-watch-started: title: watch started event type: object properties: action: type: string enum: - started example: started enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' required: - action - repository - sender webhook-workflow-dispatch: title: workflow_dispatch event type: object properties: enterprise: $ref: '#/components/schemas/enterprise-webhooks' inputs: type: object nullable: true additionalProperties: true installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' ref: type: string example: main repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow: type: string example: example_value required: - inputs - ref - repository - sender - workflow webhook-workflow-job-completed: title: workflow_job completed event type: object properties: action: type: string enum: - completed example: completed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow_job: allOf: - title: Workflow Job description: >- The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object. type: object properties: check_run_url: type: string format: uri completed_at: type: string nullable: true conclusion: type: string nullable: true enum: - success - failure - - skipped - cancelled - action_required - neutral - timed_out created_at: description: The time that the job created. type: string head_sha: type: string html_url: type: string format: uri id: type: integer labels: description: >- Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.9/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. type: array items: type: string name: type: string node_id: type: string run_attempt: type: integer run_id: type: number run_url: type: string format: uri runner_group_id: description: >- The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: integer nullable: true runner_group_name: description: >- The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: string nullable: true runner_id: description: >- The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: integer nullable: true runner_name: description: >- The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: string nullable: true started_at: type: string status: description: >- The current status of the job. Can be `queued`, `in_progress`, `waiting`, or `completed`. type: string enum: - queued - in_progress - completed - waiting head_branch: type: string description: The name of the current branch. nullable: true workflow_name: type: string description: The name of the workflow. nullable: true steps: type: array items: title: Workflow Step type: object properties: completed_at: type: string nullable: true conclusion: type: string nullable: true enum: - failure - skipped - success - cancelled - name: type: string number: type: integer started_at: type: string nullable: true status: type: string enum: - in_progress - completed - queued required: - name - status - conclusion - number - started_at - completed_at url: type: string format: uri required: - id - run_id - run_url - run_attempt - node_id - head_sha - url - html_url - status - conclusion - started_at - completed_at - name - steps - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - workflow_name - head_branch - created_at - type: object properties: check_run_url: type: string completed_at: type: string conclusion: type: string enum: - success - failure - skipped - cancelled - action_required - neutral - timed_out created_at: description: The time that the job created. type: string head_sha: type: string html_url: type: string id: type: integer labels: type: array items: type: string nullable: true name: type: string node_id: type: string run_attempt: type: integer run_id: type: integer run_url: type: string runner_group_id: type: number nullable: true runner_group_name: type: string nullable: true runner_id: type: number nullable: true runner_name: type: string nullable: true started_at: type: string status: type: string head_branch: type: string description: The name of the current branch. nullable: true workflow_name: type: string description: The name of the workflow. nullable: true steps: type: array items: type: object nullable: true url: type: string required: - conclusion example: example_value deployment: $ref: '#/components/schemas/deployment' required: - action - repository - sender - workflow_job webhook-workflow-job-in-progress: title: workflow_job in_progress event type: object properties: action: type: string enum: - in_progress example: in_progress enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow_job: allOf: - title: Workflow Job description: >- The workflow job. Many `workflow_job` keys, such as `head_sha`, `conclusion`, and `started_at` are the same as those in a [`check_run`](#check_run) object. type: object properties: check_run_url: type: string format: uri completed_at: type: string nullable: true conclusion: type: string nullable: true enum: - success - failure - - cancelled - neutral created_at: description: The time that the job created. type: string head_sha: type: string html_url: type: string format: uri id: type: integer labels: description: >- Custom labels for the job. Specified by the [`"runs-on"` attribute](https://docs.github.com/enterprise-server@3.9/actions/reference/workflow-syntax-for-github-actions#jobsjob_idruns-on) in the workflow YAML. type: array items: type: string name: type: string node_id: type: string run_attempt: type: integer run_id: type: number run_url: type: string format: uri runner_group_id: description: >- The ID of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: integer nullable: true runner_group_name: description: >- The name of the runner group that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: string nullable: true runner_id: description: >- The ID of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: integer nullable: true runner_name: description: >- The name of the runner that is running this job. This will be `null` as long as `workflow_job[status]` is `queued`. type: string nullable: true started_at: type: string status: description: >- The current status of the job. Can be `queued`, `in_progress`, or `completed`. type: string enum: - queued - in_progress - completed head_branch: type: string description: The name of the current branch. nullable: true workflow_name: type: string description: The name of the workflow. nullable: true steps: type: array items: title: Workflow Step type: object properties: completed_at: type: string nullable: true conclusion: type: string nullable: true enum: - failure - skipped - success - - cancelled name: type: string number: type: integer started_at: type: string nullable: true status: type: string enum: - in_progress - completed - queued - pending required: - name - status - conclusion - number - started_at - completed_at url: type: string format: uri required: - id - run_id - run_url - run_attempt - node_id - head_sha - url - html_url - status - conclusion - started_at - completed_at - name - steps - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - workflow_name - head_branch - created_at - type: object properties: check_run_url: type: string completed_at: type: string nullable: true conclusion: type: string nullable: true created_at: description: The time that the job created. type: string head_sha: type: string html_url: type: string id: type: integer labels: type: array items: type: string name: type: string node_id: type: string run_attempt: type: integer run_id: type: integer run_url: type: string runner_group_id: type: number nullable: true runner_group_name: type: string nullable: true runner_id: type: number nullable: true runner_name: type: string nullable: true started_at: type: string status: type: string enum: - in_progress - completed - queued head_branch: type: string description: The name of the current branch. nullable: true workflow_name: type: string description: The name of the workflow. nullable: true steps: type: array items: title: Workflow Step type: object properties: completed_at: type: string nullable: true conclusion: type: string nullable: true name: type: string number: type: integer started_at: type: string nullable: true status: type: string enum: - in_progress - completed - pending - queued required: - name - status - conclusion - number - started_at - completed_at url: type: string required: - status - steps example: example_value deployment: $ref: '#/components/schemas/deployment' required: - action - repository - sender - workflow_job webhook-workflow-job-queued: title: workflow_job queued event type: object properties: action: type: string enum: - queued example: queued enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow_job: type: object properties: check_run_url: type: string format: uri completed_at: type: string nullable: true conclusion: type: string nullable: true created_at: description: The time that the job created. type: string head_sha: type: string html_url: type: string format: uri id: type: integer labels: type: array items: type: string name: type: string node_id: type: string run_attempt: type: integer run_id: type: number run_url: type: string format: uri runner_group_id: type: integer nullable: true runner_group_name: type: string nullable: true runner_id: type: integer nullable: true runner_name: type: string nullable: true started_at: type: string format: date-time status: type: string enum: - queued - in_progress - completed - waiting head_branch: type: string description: The name of the current branch. nullable: true workflow_name: type: string description: The name of the workflow. nullable: true steps: type: array items: title: Workflow Step type: object properties: completed_at: type: string nullable: true conclusion: type: string nullable: true enum: - failure - skipped - success - cancelled - name: type: string number: type: integer started_at: type: string nullable: true status: type: string enum: - completed - in_progress - queued - pending required: - name - status - conclusion - number - started_at - completed_at url: type: string format: uri required: - id - run_id - run_url - run_attempt - node_id - head_sha - url - html_url - status - conclusion - started_at - completed_at - name - steps - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - workflow_name - head_branch - created_at deployment: $ref: '#/components/schemas/deployment' required: - action - repository - sender - workflow_job webhook-workflow-job-waiting: title: workflow_job waiting event type: object properties: action: type: string enum: - waiting example: waiting enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow_job: type: object properties: check_run_url: type: string format: uri completed_at: type: string nullable: true conclusion: type: string nullable: true created_at: description: The time that the job created. type: string head_sha: type: string html_url: type: string format: uri id: type: integer labels: type: array items: type: string name: type: string node_id: type: string run_attempt: type: integer run_id: type: number run_url: type: string format: uri runner_group_id: type: integer nullable: true runner_group_name: type: string nullable: true runner_id: type: integer nullable: true runner_name: type: string nullable: true started_at: type: string format: date-time head_branch: type: string description: The name of the current branch. nullable: true workflow_name: type: string description: The name of the workflow. nullable: true status: type: string enum: - queued - in_progress - completed - waiting steps: type: array items: title: Workflow Step type: object properties: completed_at: type: string nullable: true conclusion: type: string nullable: true enum: - failure - skipped - success - cancelled - name: type: string number: type: integer started_at: type: string nullable: true status: type: string enum: - completed - in_progress - queued - pending - waiting required: - name - status - conclusion - number - started_at - completed_at url: type: string format: uri required: - id - run_id - run_url - run_attempt - node_id - head_sha - url - html_url - status - conclusion - started_at - completed_at - name - steps - check_run_url - labels - runner_id - runner_name - runner_group_id - runner_group_name - workflow_name - head_branch - created_at deployment: $ref: '#/components/schemas/deployment' required: - action - repository - sender - workflow_job webhook-workflow-run-completed: title: workflow_run completed event type: object properties: action: type: string enum: - completed example: completed enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow: title: Workflow type: object nullable: true properties: badge_url: type: string format: uri created_at: type: string format: date-time html_url: type: string format: uri id: type: integer name: type: string node_id: type: string path: type: string state: type: string updated_at: type: string format: date-time url: type: string format: uri required: - badge_url - created_at - html_url - id - name - node_id - path - state - updated_at - url workflow_run: allOf: - title: Workflow Run type: object properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string format: uri cancel_url: type: string format: uri check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string format: uri conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - - skipped created_at: type: string format: date-time event: type: string head_branch: type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_repository: title: Repository Lite type: object properties: archive_url: type: string format: uri-template assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string format: uri-template name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id private: description: Whether the repository is private or public. type: boolean pulls_url: type: string format: uri-template releases_url: type: string format: uri-template stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string format: uri-template url: type: string format: uri 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 - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - node_id - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string format: uri logs_url: type: string format: uri name: type: string nullable: true node_id: type: string path: type: string previous_attempt_url: type: string nullable: true format: uri pull_requests: type: array items: type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: number number: type: number url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: title: Repository Lite type: object properties: archive_url: type: string format: uri-template assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string format: uri-template name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id private: description: Whether the repository is private or public. type: boolean pulls_url: type: string format: uri-template releases_url: type: string format: uri-template stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string format: uri-template url: type: string format: uri 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 - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - node_id - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url rerun_url: type: string format: uri run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - pending - waiting triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string format: uri required: - artifacts_url - cancel_url - check_suite_url - check_suite_id - check_suite_node_id - conclusion - created_at - event - head_branch - head_commit - head_repository - head_sha - html_url - id - jobs_url - logs_url - node_id - name - path - pull_requests - repository - rerun_url - run_number - status - updated_at - url - workflow_id - workflow_url - run_attempt - run_started_at - previous_attempt_url - actor - triggering_actor - type: object properties: actor: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - skipped created_at: type: string event: type: string head_branch: type: string nullable: true head_commit: type: object properties: author: type: object properties: email: type: string name: type: string committer: type: object properties: email: type: string name: type: string id: type: string message: type: string timestamp: type: string tree_id: type: string head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string id: type: integer jobs_url: type: string logs_url: type: string name: type: string nullable: true node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: type: object nullable: true referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string status: type: string triggering_actor: type: object nullable: true properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string updated_at: type: string url: type: string workflow_id: type: integer workflow_url: type: string required: - conclusion example: example_value required: - action - repository - sender - workflow - workflow_run webhook-workflow-run-in-progress: title: workflow_run in_progress event type: object properties: action: type: string enum: - in_progress example: in_progress enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow: title: Workflow type: object nullable: true properties: badge_url: type: string format: uri created_at: type: string format: date-time html_url: type: string format: uri id: type: integer name: type: string node_id: type: string path: type: string state: type: string updated_at: type: string format: date-time url: type: string format: uri required: - badge_url - created_at - html_url - id - name - node_id - path - state - updated_at - url workflow_run: allOf: - title: Workflow Run type: object properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string format: uri cancel_url: type: string format: uri check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string format: uri conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - skipped - created_at: type: string format: date-time event: type: string head_branch: type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_repository: title: Repository Lite type: object properties: archive_url: type: string format: uri-template assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string format: uri-template name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id private: description: Whether the repository is private or public. type: boolean pulls_url: type: string format: uri-template releases_url: type: string format: uri-template stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string format: uri-template url: type: string format: uri 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 - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - node_id - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string format: uri logs_url: type: string format: uri name: type: string nullable: true node_id: type: string path: type: string previous_attempt_url: type: string nullable: true format: uri pull_requests: type: array items: type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: number number: type: number url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: title: Repository Lite type: object properties: archive_url: type: string format: uri-template assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string format: uri-template name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id private: description: Whether the repository is private or public. type: boolean pulls_url: type: string format: uri-template releases_url: type: string format: uri-template stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string format: uri-template url: type: string format: uri 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 - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - node_id - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url rerun_url: type: string format: uri run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - pending triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string format: uri required: - artifacts_url - cancel_url - check_suite_url - check_suite_id - check_suite_node_id - conclusion - created_at - event - head_branch - head_commit - head_repository - head_sha - html_url - id - jobs_url - logs_url - node_id - name - path - pull_requests - repository - rerun_url - run_number - status - updated_at - url - workflow_id - workflow_url - run_attempt - run_started_at - previous_attempt_url - actor - triggering_actor - type: object properties: actor: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string artifacts_url: type: string cancel_url: type: string check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - skipped - stale created_at: type: string event: type: string head_branch: type: string nullable: true head_commit: type: object properties: author: type: object properties: email: type: string name: type: string committer: type: object properties: email: type: string name: type: string id: type: string message: type: string timestamp: type: string tree_id: type: string head_repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string nullable: true node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string head_sha: type: string html_url: type: string id: type: integer jobs_url: type: string logs_url: type: string name: type: string nullable: true node_id: type: string path: type: string previous_attempt_url: type: string nullable: true pull_requests: type: array items: type: object nullable: true referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string description: type: string nullable: true downloads_url: type: string events_url: type: string fork: type: boolean forks_url: type: string full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string html_url: type: string id: type: integer issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string name: type: string node_id: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string url: type: string rerun_url: type: string run_attempt: type: integer run_number: type: integer run_started_at: type: string status: type: string triggering_actor: type: object properties: avatar_url: type: string events_url: type: string followers_url: type: string following_url: type: string gists_url: type: string gravatar_id: type: string html_url: type: string id: type: integer login: type: string node_id: type: string organizations_url: type: string received_events_url: type: string repos_url: type: string site_admin: type: boolean starred_url: type: string subscriptions_url: type: string type: type: string url: type: string updated_at: type: string url: type: string workflow_id: type: integer workflow_url: type: string required: - conclusion example: example_value required: - action - repository - sender - workflow - workflow_run webhook-workflow-run-requested: title: workflow_run requested event type: object properties: action: type: string enum: - requested example: requested enterprise: $ref: '#/components/schemas/enterprise-webhooks' installation: $ref: '#/components/schemas/simple-installation' organization: $ref: '#/components/schemas/organization-simple-webhooks' repository: $ref: '#/components/schemas/repository-webhooks' sender: $ref: '#/components/schemas/simple-user-webhooks' workflow: title: Workflow type: object nullable: true properties: badge_url: type: string format: uri created_at: type: string format: date-time html_url: type: string format: uri id: type: integer name: type: string node_id: type: string path: type: string state: type: string updated_at: type: string format: date-time url: type: string format: uri required: - badge_url - created_at - html_url - id - name - node_id - path - state - updated_at - url workflow_run: title: Workflow Run type: object properties: actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id artifacts_url: type: string format: uri cancel_url: type: string format: uri check_suite_id: type: integer check_suite_node_id: type: string check_suite_url: type: string format: uri conclusion: type: string nullable: true enum: - success - failure - neutral - cancelled - timed_out - action_required - stale - - skipped - startup_failure created_at: type: string format: date-time event: type: string head_branch: type: string nullable: true head_commit: title: SimpleCommit type: object properties: author: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name committer: title: Committer description: Metaproperties for Git author/committer information. type: object properties: date: type: string format: date-time email: type: string nullable: true format: email name: description: The git author's name. type: string username: type: string required: - email - name id: type: string message: type: string timestamp: type: string tree_id: type: string required: - id - tree_id - message - timestamp - author - committer head_repository: title: Repository Lite type: object properties: archive_url: type: string format: uri-template assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string format: uri-template name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id private: description: Whether the repository is private or public. type: boolean pulls_url: type: string format: uri-template releases_url: type: string format: uri-template stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string format: uri-template url: type: string format: uri 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 - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - node_id - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url head_sha: type: string html_url: type: string format: uri id: type: integer jobs_url: type: string format: uri logs_url: type: string format: uri name: type: string nullable: true node_id: type: string path: type: string previous_attempt_url: type: string nullable: true format: uri pull_requests: type: array items: type: object properties: base: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo head: type: object properties: ref: type: string repo: title: Repo Ref type: object properties: id: type: integer name: type: string url: type: string format: uri required: - id - url - name sha: type: string required: - ref - sha - repo id: type: number number: type: number url: type: string format: uri required: - url - id - number - head - base referenced_workflows: type: array nullable: true items: type: object properties: path: type: string ref: type: string sha: type: string required: - path - sha repository: title: Repository Lite type: object properties: archive_url: type: string format: uri-template assignees_url: type: string format: uri-template blobs_url: type: string format: uri-template branches_url: type: string format: uri-template collaborators_url: type: string format: uri-template comments_url: type: string format: uri-template commits_url: type: string format: uri-template compare_url: type: string format: uri-template contents_url: type: string format: uri-template contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string format: uri-template git_refs_url: type: string format: uri-template git_tags_url: type: string format: uri-template hooks_url: type: string format: uri html_url: type: string format: uri id: description: Unique identifier of the repository type: integer issue_comment_url: type: string format: uri-template issue_events_url: type: string format: uri-template issues_url: type: string format: uri-template keys_url: type: string format: uri-template labels_url: type: string format: uri-template languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string format: uri-template name: description: The name of the repository. type: string node_id: type: string notifications_url: type: string format: uri-template owner: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id private: description: Whether the repository is private or public. type: boolean pulls_url: type: string format: uri-template releases_url: type: string format: uri-template stargazers_url: type: string format: uri statuses_url: type: string format: uri-template subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string format: uri-template url: type: string format: uri 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 - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - node_id - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url rerun_url: type: string format: uri run_attempt: type: integer run_number: type: integer run_started_at: type: string format: date-time status: type: string enum: - requested - in_progress - completed - queued - pending - waiting triggering_actor: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id updated_at: type: string format: date-time url: type: string format: uri workflow_id: type: integer workflow_url: type: string format: uri display_title: type: string required: - artifacts_url - cancel_url - check_suite_url - check_suite_id - check_suite_node_id - conclusion - created_at - event - head_branch - head_commit - head_repository - head_sha - html_url - id - jobs_url - logs_url - node_id - name - path - pull_requests - repository - rerun_url - run_number - status - updated_at - url - workflow_id - workflow_url - run_attempt - run_started_at - previous_attempt_url - actor - triggering_actor - display_title required: - action - repository - sender - workflow - workflow_run enterprise-webhooks: title: Enterprise description: > An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured on an enterprise account or an organization that's part of an enterprise account. For more information, see "[About enterprise accounts](https://docs.github.com/enterprise-server@3.9/admin/overview/about-enterprise-accounts)." 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 simple-installation: title: Simple Installation description: >- The GitHub App installation. Webhook payloads contain the `installation` property when the event is configured for and sent to a GitHub App. For more information, see "[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-server@3.9/apps/creating-github-apps/registering-a-github-app/using-webhooks-with-github-apps)." type: object properties: id: description: The ID of the installation. type: integer example: 1 node_id: description: The global node ID of the installation. type: string example: MDQ6VXNlcjU4MzIzMQ== required: - id - node_id organization-simple-webhooks: title: Organization Simple description: >- A GitHub organization. Webhook payloads contain the `organization` property when the webhook is configured for an organization, or when the event occurs from activity in a repository owned by an 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 repository-webhooks: title: Repository description: >- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. 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' organization: $ref: '#/components/schemas/nullable-simple-user' 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 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 template_repository: nullable: true type: object properties: id: type: integer node_id: type: string name: type: string full_name: type: string owner: type: object properties: login: type: string id: type: integer node_id: type: string avatar_url: type: string gravatar_id: type: string url: type: string html_url: type: string followers_url: type: string following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string organizations_url: type: string repos_url: type: string events_url: type: string received_events_url: type: string type: type: string site_admin: type: boolean private: type: boolean html_url: type: string description: type: string fork: type: boolean url: type: string archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string downloads_url: type: string events_url: type: string forks_url: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string git_url: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string notifications_url: type: string pulls_url: type: string releases_url: type: string ssh_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string clone_url: type: string mirror_url: type: string hooks_url: type: string svn_url: type: string homepage: type: string language: type: string forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: 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 archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string created_at: type: string updated_at: type: string permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean allow_rebase_merge: type: boolean temp_clone_token: type: string allow_squash_merge: type: boolean allow_auto_merge: type: boolean delete_branch_on_merge: type: boolean allow_update_branch: type: boolean use_squash_pr_title_as_default: type: boolean 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: type: boolean subscribers_count: type: integer network_count: type: integer 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 subscribers_count: type: integer network_count: type: integer 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 simple-user-webhooks: title: Simple User description: >- The GitHub user that triggered the event. This property is included in every webhook payload. 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 check-run-with-simple-check-suite: title: CheckRun description: A check performed on the code of a given code change type: object properties: app: $ref: '#/components/schemas/nullable-integration' check_suite: $ref: '#/components/schemas/simple-check-suite' completed_at: example: '2018-05-04T01:14:52Z' type: string nullable: true format: date-time conclusion: example: neutral type: string nullable: true enum: - waiting - pending - startup_failure - stale - success - failure - neutral - cancelled - skipped - timed_out - action_required deployment: $ref: '#/components/schemas/deployment-simple' details_url: example: https://example.com type: string external_id: example: '42' type: string head_sha: description: The SHA of the commit that is being checked. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string html_url: example: https://github.com/github/hello-world/runs/4 type: string id: description: The id of the check. example: 21 type: integer name: description: The name of the check. example: test-coverage type: string node_id: example: MDg6Q2hlY2tSdW40 type: string output: type: object properties: annotations_count: type: integer annotations_url: type: string format: uri summary: type: string nullable: true text: type: string nullable: true title: type: string nullable: true required: - title - summary - text - annotations_count - annotations_url pull_requests: type: array items: $ref: '#/components/schemas/pull-request-minimal' started_at: example: '2018-05-04T01:14:52Z' type: string format: date-time status: description: The phase of the lifecycle that the check is currently in. example: queued type: string enum: - queued - in_progress - completed - pending url: example: https://api.github.com/repos/github/hello-world/check-runs/4 type: string required: - id - node_id - head_sha - name - url - html_url - details_url - status - conclusion - started_at - completed_at - external_id - check_suite - output - app - pull_requests code-scanning-alert-dismissed-comment: type: string description: The dismissal comment associated with the dismissal of the alert. nullable: true maxLength: 280 dependabot-alert: type: object description: A Dependabot alert. properties: number: $ref: '#/components/schemas/alert-number' state: type: string description: The state of the Dependabot alert. readOnly: true enum: - auto_dismissed - dismissed - fixed - open example: auto_dismissed dependency: type: object description: Details for the vulnerable dependency. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' manifest_path: type: string description: >- The full path to the dependency manifest file, relative to the root of the repository. readOnly: true scope: type: string description: The execution scope of the vulnerable dependency. readOnly: true nullable: true enum: - development - runtime security_advisory: $ref: '#/components/schemas/dependabot-alert-security-advisory' security_vulnerability: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/alert-updated-at' dismissed_at: $ref: '#/components/schemas/alert-dismissed-at' dismissed_by: $ref: '#/components/schemas/nullable-simple-user' dismissed_reason: type: string description: The reason that the alert was dismissed. nullable: true enum: - fix_started - inaccurate - no_bandwidth - not_used - tolerable_risk example: fix_started dismissed_comment: type: string description: An optional comment associated with the alert's dismissal. nullable: true maxLength: 280 example: example_value fixed_at: $ref: '#/components/schemas/alert-fixed-at' auto_dismissed_at: $ref: '#/components/schemas/alert-auto-dismissed-at' required: - number - state - dependency - security_advisory - security_vulnerability - url - html_url - created_at - updated_at - dismissed_at - dismissed_by - dismissed_reason - dismissed_comment - fixed_at additionalProperties: false discussion: title: Discussion description: A Discussion in a repository. type: object properties: active_lock_reason: type: string nullable: true example: example_value answer_chosen_at: type: string nullable: true example: '2026-04-17T12:00:00Z' answer_chosen_by: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id answer_html_url: type: string nullable: true example: https://api.github.com/repos/octocat/Hello-World author_association: title: AuthorAssociation description: How the author is associated with the repository. type: string enum: - COLLABORATOR - CONTRIBUTOR - FIRST_TIMER - FIRST_TIME_CONTRIBUTOR - MANNEQUIN - MEMBER - NONE - OWNER example: COLLABORATOR body: type: string example: Example body text category: type: object properties: created_at: type: string format: date-time description: type: string emoji: type: string id: type: integer is_answerable: type: boolean name: type: string node_id: type: string repository_id: type: integer slug: type: string updated_at: type: string required: - id - repository_id - emoji - name - description - created_at - updated_at - slug - is_answerable comments: type: integer example: 42 created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' html_url: type: string example: https://api.github.com/repos/octocat/Hello-World id: type: integer example: 42 locked: type: boolean example: true node_id: type: string example: '12345678' number: type: integer example: 42 reactions: title: Reactions type: object properties: '+1': type: integer '-1': type: integer confused: type: integer eyes: type: integer heart: type: integer hooray: type: integer laugh: type: integer rocket: type: integer total_count: type: integer url: type: string format: uri required: - url - total_count - '+1' - '-1' - laugh - confused - heart - hooray - eyes - rocket repository_url: type: string example: https://api.github.com/repos/octocat/Hello-World state: type: string description: >- The current state of the discussion. `converting` means that the discussion is being converted from an issue. `transferring` means that the discussion is being transferred from another repository. enum: - open - closed - locked - converting - transferring example: open state_reason: description: The reason for the current state example: resolved type: string nullable: true enum: - resolved - outdated - duplicate - reopened timeline_url: type: string example: https://api.github.com/repos/octocat/Hello-World title: type: string example: Example Title updated_at: type: string format: date-time user: title: User type: object nullable: true properties: avatar_url: type: string format: uri deleted: type: boolean email: type: string nullable: true events_url: type: string format: uri-template followers_url: type: string format: uri following_url: type: string format: uri-template gists_url: type: string format: uri-template gravatar_id: type: string html_url: type: string format: uri id: type: integer login: type: string name: type: string node_id: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string format: uri-template subscriptions_url: type: string format: uri type: type: string enum: - Bot - User - Organization url: type: string format: uri required: - login - id required: - repository_url - category - answer_html_url - answer_chosen_at - answer_chosen_by - html_url - id - node_id - number - title - user - state - state_reason - locked - comments - created_at - updated_at - author_association - active_lock_reason - body 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 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 nullable-repository-webhooks: title: Repository description: >- The repository on GitHub where the event occurred. Webhook payloads contain the `repository` property when the event occurs from activity in a repository. 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' organization: $ref: '#/components/schemas/nullable-simple-user' 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 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 template_repository: nullable: true type: object properties: id: type: integer node_id: type: string name: type: string full_name: type: string owner: type: object properties: login: type: string id: type: integer node_id: type: string avatar_url: type: string gravatar_id: type: string url: type: string html_url: type: string followers_url: type: string following_url: type: string gists_url: type: string starred_url: type: string subscriptions_url: type: string organizations_url: type: string repos_url: type: string events_url: type: string received_events_url: type: string type: type: string site_admin: type: boolean private: type: boolean html_url: type: string description: type: string fork: type: boolean url: type: string archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string deployments_url: type: string downloads_url: type: string events_url: type: string forks_url: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string git_url: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string merges_url: type: string milestones_url: type: string notifications_url: type: string pulls_url: type: string releases_url: type: string ssh_url: type: string stargazers_url: type: string statuses_url: type: string subscribers_url: type: string subscription_url: type: string tags_url: type: string teams_url: type: string trees_url: type: string clone_url: type: string mirror_url: type: string hooks_url: type: string svn_url: type: string homepage: type: string language: type: string forks_count: type: integer stargazers_count: type: integer watchers_count: type: integer size: 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 archived: type: boolean disabled: type: boolean visibility: type: string pushed_at: type: string created_at: type: string updated_at: type: string permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean allow_rebase_merge: type: boolean temp_clone_token: type: string allow_squash_merge: type: boolean allow_auto_merge: type: boolean delete_branch_on_merge: type: boolean allow_update_branch: type: boolean use_squash_pr_title_as_default: type: boolean 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: type: boolean subscribers_count: type: integer network_count: type: integer 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 subscribers_count: type: integer network_count: type: integer 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 webhook-rubygems-metadata: title: Ruby Gems metadata type: object properties: name: type: string example: octocat description: type: string example: This is an example repository readme: type: string example: example_value homepage: type: string example: example_value version_info: type: object properties: version: type: string platform: type: string example: example_value metadata: type: object additionalProperties: type: string repo: type: string example: example_value dependencies: type: array items: type: object additionalProperties: type: string commit_oid: type: string example: '12345678' webhook-config-content-type: type: string description: >- The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`. example: '"json"' webhook-config-insecure-ssl: oneOf: - type: string description: >- Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.** example: '"0"' - type: number webhook-config-secret: type: string description: >- If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/enterprise-server@3.9/webhooks/event-payloads/#delivery-headers). example: '"********"' webhook-config-url: type: string description: The URL to which the payloads will be delivered. example: https://example.com/webhook format: uri hook-response: title: Hook Response type: object properties: code: type: integer nullable: true example: 42 status: type: string nullable: true example: open message: type: string nullable: true example: Example body text required: - code - status - message projects-v2: title: Projects v2 Project description: A projects v2 project type: object properties: id: type: number example: 42.5 node_id: type: string example: '12345678' owner: $ref: '#/components/schemas/simple-user' creator: $ref: '#/components/schemas/simple-user' title: type: string example: Example Title description: type: string nullable: true example: This is an example repository public: type: boolean example: true closed_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' number: type: integer example: 42 short_description: type: string nullable: true example: This is an example repository deleted_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true deleted_by: $ref: '#/components/schemas/nullable-simple-user' required: - id - node_id - owner - creator - title - description - public - closed_at - created_at - updated_at - number - short_description - deleted_at - deleted_by projects-v2-item: title: Projects v2 Item description: An item belonging to a project type: object properties: id: type: number example: 42.5 node_id: type: string example: '12345678' project_node_id: type: string example: '12345678' content_node_id: type: string example: '12345678' content_type: $ref: '#/components/schemas/projects-v2-item-content-type' creator: $ref: '#/components/schemas/simple-user' created_at: type: string format: date-time example: '2022-04-28T12:00:00Z' updated_at: type: string format: date-time example: '2022-04-28T12:00:00Z' archived_at: type: string format: date-time example: '2022-04-28T12:00:00Z' nullable: true required: - id - content_node_id - content_type - created_at - updated_at - archived_at pull-request: type: object title: Pull Request description: >- Pull requests let you tell others about changes you've pushed to a repository on GitHub. Once a pull request is sent, interested parties can review the set of changes, discuss potential modifications, and even push follow-up commits if necessary. properties: url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347 id: type: integer example: 1 node_id: type: string example: MDExOlB1bGxSZXF1ZXN0MQ== html_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347 diff_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.diff patch_url: type: string format: uri example: https://github.com/octocat/Hello-World/pull/1347.patch issue_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/issues/1347 commits_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits review_comments_url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments review_comment_url: type: string example: >- https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number} comments_url: type: string format: uri example: >- https://api.github.com/repos/octocat/Hello-World/issues/1347/comments statuses_url: type: string format: uri example: >- https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e number: description: Number uniquely identifying the pull request within its repository. example: 42 type: integer state: description: State of this Pull Request. Either `open` or `closed`. enum: - open - closed example: open type: string locked: type: boolean example: true title: description: The title of the pull request. example: Amazing new feature type: string user: $ref: '#/components/schemas/simple-user' body: type: string example: Please pull these awesome changes nullable: true labels: type: array items: type: object properties: id: type: integer format: int64 node_id: type: string url: type: string name: type: string description: type: string nullable: true color: type: string default: type: boolean required: - id - node_id - url - name - description - color - default milestone: $ref: '#/components/schemas/nullable-milestone' active_lock_reason: type: string example: too heated nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' updated_at: type: string format: date-time example: '2011-01-26T19:01:12Z' closed_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true merged_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true merge_commit_sha: type: string example: e5bd3914e2e596debea16f433f57875b5b90bcd6 nullable: true assignee: $ref: '#/components/schemas/nullable-simple-user' assignees: type: array items: $ref: '#/components/schemas/simple-user' nullable: true requested_reviewers: type: array items: $ref: '#/components/schemas/simple-user' nullable: true requested_teams: type: array items: $ref: '#/components/schemas/team-simple' nullable: true head: type: object properties: label: type: string ref: type: string repo: type: object nullable: true properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string format: uri html_url: type: string format: uri id: type: integer node_id: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string name: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string format: uri statuses_url: type: string subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string url: type: string format: uri clone_url: type: string default_branch: type: string forks: type: integer forks_count: type: integer git_url: type: string has_downloads: type: boolean has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_discussions: type: boolean homepage: type: string format: uri nullable: true language: type: string nullable: true master_branch: type: string archived: type: boolean disabled: type: boolean visibility: description: 'The repository visibility: public, private, or internal.' type: string mirror_url: type: string format: uri nullable: true open_issues: type: integer open_issues_count: type: integer permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean required: - admin - pull - push temp_clone_token: type: string allow_merge_commit: type: boolean allow_squash_merge: type: boolean allow_rebase_merge: type: boolean license: type: object properties: key: type: string name: type: string url: type: string format: uri nullable: true spdx_id: type: string nullable: true node_id: type: string required: - key - name - url - spdx_id - node_id nullable: true pushed_at: type: string format: date-time size: type: integer ssh_url: type: string stargazers_count: type: integer svn_url: type: string format: uri topics: type: array items: type: string watchers: type: integer watchers_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time allow_forking: type: boolean is_template: type: boolean web_commit_signoff_required: type: boolean required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - has_discussions - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at sha: type: string user: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url required: - label - ref - repo - sha - user base: type: object properties: label: type: string ref: type: string repo: type: object properties: archive_url: type: string assignees_url: type: string blobs_url: type: string branches_url: type: string collaborators_url: type: string comments_url: type: string commits_url: type: string compare_url: type: string contents_url: type: string contributors_url: type: string format: uri deployments_url: type: string format: uri description: type: string nullable: true downloads_url: type: string format: uri events_url: type: string format: uri fork: type: boolean forks_url: type: string format: uri full_name: type: string git_commits_url: type: string git_refs_url: type: string git_tags_url: type: string hooks_url: type: string format: uri html_url: type: string format: uri id: type: integer is_template: type: boolean node_id: type: string issue_comment_url: type: string issue_events_url: type: string issues_url: type: string keys_url: type: string labels_url: type: string languages_url: type: string format: uri merges_url: type: string format: uri milestones_url: type: string name: type: string notifications_url: type: string owner: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url private: type: boolean pulls_url: type: string releases_url: type: string stargazers_url: type: string format: uri statuses_url: type: string subscribers_url: type: string format: uri subscription_url: type: string format: uri tags_url: type: string format: uri teams_url: type: string format: uri trees_url: type: string url: type: string format: uri clone_url: type: string default_branch: type: string forks: type: integer forks_count: type: integer git_url: type: string has_downloads: type: boolean has_issues: type: boolean has_projects: type: boolean has_wiki: type: boolean has_pages: type: boolean has_discussions: type: boolean homepage: type: string format: uri nullable: true language: type: string nullable: true master_branch: type: string archived: type: boolean disabled: type: boolean visibility: description: 'The repository visibility: public, private, or internal.' type: string mirror_url: type: string format: uri nullable: true open_issues: type: integer open_issues_count: type: integer permissions: type: object properties: admin: type: boolean maintain: type: boolean push: type: boolean triage: type: boolean pull: type: boolean required: - admin - pull - push temp_clone_token: type: string allow_merge_commit: type: boolean allow_squash_merge: type: boolean allow_rebase_merge: type: boolean license: $ref: '#/components/schemas/nullable-license-simple' pushed_at: type: string format: date-time size: type: integer ssh_url: type: string stargazers_count: type: integer svn_url: type: string format: uri topics: type: array items: type: string watchers: type: integer watchers_count: type: integer created_at: type: string format: date-time updated_at: type: string format: date-time allow_forking: type: boolean web_commit_signoff_required: type: boolean required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - has_discussions - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at sha: type: string user: type: object properties: avatar_url: type: string format: uri events_url: type: string followers_url: type: string format: uri following_url: type: string gists_url: type: string gravatar_id: type: string nullable: true html_url: type: string format: uri id: type: integer node_id: type: string login: type: string organizations_url: type: string format: uri received_events_url: type: string format: uri repos_url: type: string format: uri site_admin: type: boolean starred_url: type: string subscriptions_url: type: string format: uri type: type: string url: type: string format: uri required: - avatar_url - events_url - followers_url - following_url - gists_url - gravatar_id - html_url - id - node_id - login - organizations_url - received_events_url - repos_url - site_admin - starred_url - subscriptions_url - type - url required: - label - ref - repo - sha - user _links: type: object properties: comments: $ref: '#/components/schemas/link' commits: $ref: '#/components/schemas/link' statuses: $ref: '#/components/schemas/link' html: $ref: '#/components/schemas/link' issue: $ref: '#/components/schemas/link' review_comments: $ref: '#/components/schemas/link' review_comment: $ref: '#/components/schemas/link' self: $ref: '#/components/schemas/link' required: - comments - commits - statuses - html - issue - review_comments - review_comment - self author_association: $ref: '#/components/schemas/author-association' auto_merge: $ref: '#/components/schemas/auto-merge' draft: description: Indicates whether or not the pull request is a draft. example: false type: boolean merged: type: boolean mergeable: type: boolean example: true nullable: true rebaseable: type: boolean example: true nullable: true mergeable_state: type: string example: clean merged_by: $ref: '#/components/schemas/nullable-simple-user' comments: type: integer example: 10 review_comments: type: integer example: 0 maintainer_can_modify: description: Indicates whether maintainers can modify the pull request. example: true type: boolean commits: type: integer example: 3 additions: type: integer example: 100 deletions: type: integer example: 3 changed_files: type: integer example: 5 required: - _links - assignee - labels - base - body - closed_at - comments_url - commits_url - created_at - diff_url - head - html_url - id - node_id - issue_url - merge_commit_sha - merged_at - milestone - number - patch_url - review_comment_url - review_comments_url - statuses_url - state - locked - title - updated_at - url - user - author_association - auto_merge - additions - changed_files - comments - commits - deletions - mergeable - mergeable_state - merged - maintainer_can_modify - merged_by - review_comments 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 secret-scanning-alert-webhook: type: object properties: number: $ref: '#/components/schemas/alert-number' created_at: $ref: '#/components/schemas/alert-created-at' updated_at: $ref: '#/components/schemas/nullable-alert-updated-at' url: $ref: '#/components/schemas/alert-url' html_url: $ref: '#/components/schemas/alert-html-url' locations_url: type: string format: uri description: The REST API URL of the code locations for this alert. example: https://api.github.com/repos/octocat/Hello-World resolution: $ref: '#/components/schemas/secret-scanning-alert-resolution-webhook' resolved_at: type: string format: date-time description: >- The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. nullable: true example: '2026-04-17T12:00:00Z' resolved_by: $ref: '#/components/schemas/nullable-simple-user' resolution_comment: type: string description: An optional comment to resolve an alert. nullable: true example: example_value secret_type: type: string description: The type of secret that secret scanning detected. example: User validity: type: string description: The token status as of the latest validity check. enum: - active - inactive - unknown example: active push_protection_bypassed: type: boolean description: Whether push protection was bypassed for the detected secret. nullable: true example: true push_protection_bypassed_by: $ref: '#/components/schemas/nullable-simple-user' push_protection_bypassed_at: type: string format: date-time description: >- The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. nullable: true example: '2026-04-17T12:00:00Z' secret-scanning-location: type: object properties: type: type: string enum: - commit - issue_title - issue_body - issue_comment - discussion_title - discussion_body - discussion_comment - pull_request_title - pull_request_body - pull_request_comment - pull_request_review - pull_request_review_comment description: >- The location type. Because secrets may be found in different types of resources (ie. code, comments, issues, pull requests, discussions), this field identifies the type of resource where the secret was found. example: commit details: oneOf: - $ref: '#/components/schemas/secret-scanning-location-commit' - $ref: '#/components/schemas/secret-scanning-location-issue-title' - $ref: '#/components/schemas/secret-scanning-location-issue-body' - $ref: '#/components/schemas/secret-scanning-location-issue-comment' - $ref: '#/components/schemas/secret-scanning-location-discussion-title' - $ref: '#/components/schemas/secret-scanning-location-discussion-body' - $ref: '#/components/schemas/secret-scanning-location-discussion-comment' - $ref: '#/components/schemas/secret-scanning-location-pull-request-title' - $ref: '#/components/schemas/secret-scanning-location-pull-request-body' - $ref: >- #/components/schemas/secret-scanning-location-pull-request-comment - $ref: >- #/components/schemas/secret-scanning-location-pull-request-review - $ref: >- #/components/schemas/secret-scanning-location-pull-request-review-comment example: example_value required: - type - details security-and-analysis: 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 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. - `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 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' 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 deployment: title: Deployment description: A request for a specific ref(branch,sha,tag) to be deployed type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment example: 42 type: integer node_id: type: string example: MDEwOkRlcGxveW1lbnQx sha: type: string example: a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d ref: description: The ref to deploy. This can be a branch, tag, or sha. example: topic-branch type: string task: description: Parameter to specify a task to execute example: deploy type: string payload: oneOf: - type: object additionalProperties: true - type: string example: example_value original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot nullable: true creator: $ref: '#/components/schemas/nullable-simple-user' created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: >- Specifies if the given environment is will no longer exist at some point in the future. Default: false. example: true type: boolean production_environment: description: >- Specifies if the given environment is one that end-users directly interact with. Default: false. example: true type: boolean performed_via_github_app: $ref: '#/components/schemas/nullable-integration' required: - id - node_id - sha - ref - task - environment - creator - payload - description - statuses_url - repository_url - url - created_at - updated_at 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 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 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 simple-check-suite: description: A suite of checks performed on the code of a given code change type: object properties: after: example: d6fde92930d4715a2b49857d24b940956b26d2d3 type: string nullable: true app: $ref: '#/components/schemas/integration' before: example: 146e867f55c26428e5f9fade55a9bbf5e95a7912 type: string nullable: true conclusion: example: neutral type: string nullable: true enum: - success - failure - neutral - cancelled - skipped - timed_out - action_required - stale - startup_failure created_at: type: string format: date-time example: '2026-04-17T12:00:00Z' head_branch: example: master type: string nullable: true head_sha: description: The SHA of the head commit that is being checked. example: 009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d type: string id: example: 5 type: integer node_id: example: MDEwOkNoZWNrU3VpdGU1 type: string pull_requests: type: array items: $ref: '#/components/schemas/pull-request-minimal' repository: $ref: '#/components/schemas/minimal-repository' status: example: completed type: string enum: - queued - in_progress - completed - pending - waiting updated_at: type: string format: date-time example: '2026-04-17T12:00:00Z' url: example: https://api.github.com/repos/github/hello-world/check-suites/5 type: string deployment-simple: title: Deployment description: >- A deployment created as the result of an Actions check run from a workflow that references an environment type: object properties: url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1 id: description: Unique identifier of the deployment example: 42 type: integer node_id: type: string example: MDEwOkRlcGxveW1lbnQx task: description: Parameter to specify a task to execute example: deploy type: string original_environment: type: string example: staging environment: description: Name for the target deployment environment. example: production type: string description: type: string example: Deploy request from hubot nullable: true created_at: type: string format: date-time example: '2012-07-20T01:19:13Z' updated_at: type: string format: date-time example: '2012-07-20T01:19:13Z' statuses_url: type: string format: uri example: https://api.github.com/repos/octocat/example/deployments/1/statuses repository_url: type: string format: uri example: https://api.github.com/repos/octocat/example transient_environment: description: >- Specifies if the given environment is will no longer exist at some point in the future. Default: false. example: true type: boolean production_environment: description: >- Specifies if the given environment is one that end-users directly interact with. Default: false. example: true type: boolean performed_via_github_app: $ref: '#/components/schemas/nullable-integration' required: - id - node_id - task - environment - description - statuses_url - repository_url - url - created_at - updated_at pull-request-minimal: title: Pull Request Minimal type: object properties: id: type: integer example: 42 number: type: integer example: 42 url: type: string example: https://api.github.com/repos/octocat/Hello-World head: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer url: type: string name: type: string required: - id - url - name required: - ref - sha - repo base: type: object properties: ref: type: string sha: type: string repo: type: object properties: id: type: integer url: type: string name: type: string required: - id - url - name required: - ref - sha - repo required: - id - number - url - head - base alert-number: type: integer description: The security alert number. readOnly: true dependabot-alert-package: type: object description: Details for the vulnerable package. readOnly: true properties: ecosystem: type: string description: The package's language or package management ecosystem. readOnly: true example: example_value name: type: string description: The unique package name within its ecosystem. readOnly: true example: octocat required: - ecosystem - name additionalProperties: false dependabot-alert-security-advisory: type: object description: Details for the GitHub Security Advisory. readOnly: true properties: ghsa_id: type: string description: The unique GitHub Security Advisory ID assigned to the advisory. readOnly: true example: '12345678' cve_id: type: string description: The unique CVE ID assigned to the advisory. readOnly: true nullable: true example: '12345678' summary: type: string description: A short, plain text summary of the advisory. readOnly: true maxLength: 1024 example: example_value description: type: string description: A long-form Markdown-supported description of the advisory. readOnly: true example: This is an example repository vulnerabilities: type: array description: Vulnerable version range information for the advisory. readOnly: true items: $ref: '#/components/schemas/dependabot-alert-security-vulnerability' severity: type: string description: The severity of the advisory. readOnly: true enum: - low - medium - high - critical example: low cvss: type: object description: >- Details for the advisory pertaining to the Common Vulnerability Scoring System. readOnly: true properties: score: type: number description: The overall CVSS score of the advisory. minimum: 0 maximum: 10 readOnly: true vector_string: type: string description: The full CVSS vector string for the advisory. readOnly: true nullable: true required: - score - vector_string additionalProperties: false cwes: type: array description: Details for the advisory pertaining to Common Weakness Enumeration. readOnly: true items: type: object description: A CWE weakness assigned to the advisory. readOnly: true properties: cwe_id: type: string description: The unique CWE ID. readOnly: true name: type: string description: The short, plain text name of the CWE. readOnly: true required: - cwe_id - name additionalProperties: false identifiers: type: array description: >- Values that identify this advisory among security information sources. readOnly: true items: type: object description: An advisory identifier. readOnly: true properties: type: type: string description: The type of advisory identifier. readOnly: true enum: - CVE - GHSA value: type: string description: The value of the advisory identifer. readOnly: true required: - value - type additionalProperties: false references: type: array description: Links to additional advisory information. readOnly: true items: type: object description: A link to additional advisory information. readOnly: true properties: url: type: string description: The URL of the reference. format: uri readOnly: true required: - url additionalProperties: false published_at: type: string description: >- The time that the advisory was published in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true example: '2026-04-17T12:00:00Z' updated_at: type: string description: >- The time that the advisory was last modified in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true example: '2026-04-17T12:00:00Z' withdrawn_at: type: string description: >- The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true nullable: true example: '2026-04-17T12:00:00Z' required: - ghsa_id - cve_id - summary - description - vulnerabilities - severity - cvss - cwes - identifiers - references - published_at - updated_at - withdrawn_at additionalProperties: false dependabot-alert-security-vulnerability: type: object description: Details pertaining to one vulnerable version range for the advisory. readOnly: true properties: package: $ref: '#/components/schemas/dependabot-alert-package' severity: type: string description: The severity of the vulnerability. readOnly: true enum: - low - medium - high - critical example: low vulnerable_version_range: type: string description: >- Conditions that identify vulnerable versions of this vulnerability's package. readOnly: true example: example_value first_patched_version: type: object description: >- Details pertaining to the package version that patches this vulnerability. readOnly: true nullable: true properties: identifier: type: string description: The package version that patches this vulnerability. readOnly: true required: - identifier additionalProperties: false required: - package - severity - vulnerable_version_range - first_patched_version additionalProperties: false alert-url: type: string description: The REST API URL of the alert resource. format: uri readOnly: true alert-html-url: type: string description: The GitHub URL of the alert resource. format: uri readOnly: true alert-created-at: type: string description: >- The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true alert-updated-at: type: string description: >- The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true alert-dismissed-at: type: string description: >- The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true nullable: true alert-fixed-at: type: string description: >- The time that the alert was no longer detected and was considered fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true nullable: true alert-auto-dismissed-at: type: string description: >- The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true nullable: true 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 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 projects-v2-item-content-type: title: Projects v2 Item Content Type description: The type of content tracked in a project item type: string enum: - Issue - PullRequest - DraftIssue 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 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 link: title: Link description: Hypermedia Link type: object properties: href: type: string example: https://api.github.com/repos/octocat/Hello-World required: - href 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 auto-merge: title: Auto merge description: The status of auto merging a pull request. type: object properties: enabled_by: $ref: '#/components/schemas/simple-user' merge_method: type: string description: The merge method to use. enum: - merge - squash - rebase example: merge commit_title: type: string description: Title for the merge commit message. example: Example Title commit_message: type: string description: Commit message for the merge commit. example: Example body text required: - enabled_by - merge_method - commit_title - commit_message nullable: true nullable-alert-updated-at: type: string description: >- The time that the alert was last updated in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`. format: date-time readOnly: true nullable: true secret-scanning-alert-resolution-webhook: type: string description: The reason for resolving the alert. nullable: true enum: - false_positive - wont_fix - revoked - used_in_tests - pattern_deleted - pattern_edited secret-scanning-location-commit: description: >- Represents a 'commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository. type: object properties: path: type: string description: The file path in the repository example: /example/secrets.txt start_line: type: number description: Line number at which the secret starts in the file example: 42.5 end_line: type: number description: Line number at which the secret ends in the file example: 42.5 start_column: type: number description: >- The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII example: 42.5 end_column: type: number description: >- The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII example: 42.5 blob_sha: type: string description: SHA-1 hash ID of the associated blob example: af5626b4a114abcb82d63db7c8082c3c4756e51b blob_url: type: string description: The API URL to get the associated blob resource example: https://api.github.com/repos/octocat/Hello-World commit_sha: type: string description: SHA-1 hash ID of the associated commit example: af5626b4a114abcb82d63db7c8082c3c4756e51b commit_url: type: string description: The API URL to get the associated commit resource example: https://api.github.com/repos/octocat/Hello-World required: - path - start_line - end_line - start_column - end_column - blob_sha - blob_url - commit_sha - commit_url secret-scanning-location-issue-title: description: >- Represents an 'issue_title' secret scanning location type. This location type shows that a secret was detected in the title of an issue. type: object properties: issue_title_url: type: string format: uri description: The API URL to get the issue where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_title_url secret-scanning-location-issue-body: description: >- Represents an 'issue_body' secret scanning location type. This location type shows that a secret was detected in the body of an issue. type: object properties: issue_body_url: type: string format: uri description: The API URL to get the issue where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/issues/1347 required: - issue_body_url secret-scanning-location-issue-comment: description: >- Represents an 'issue_comment' secret scanning location type. This location type shows that a secret was detected in a comment on an issue. type: object properties: issue_comment_url: type: string format: uri description: The API URL to get the issue comment where the secret was detected. example: >- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - issue_comment_url secret-scanning-location-discussion-title: description: >- Represents a 'discussion_title' secret scanning location type. This location type shows that a secret was detected in the title of a discussion. type: object properties: discussion_title_url: type: string format: uri description: The URL to the discussion where the secret was detected. example: https://github.com/community/community/discussions/39082 required: - discussion_title_url secret-scanning-location-discussion-body: description: >- Represents a 'discussion_body' secret scanning location type. This location type shows that a secret was detected in the body of a discussion. type: object properties: discussion_body_url: type: string format: uri description: The URL to the discussion where the secret was detected. example: >- https://github.com/community/community/discussions/39082#discussion-4566270 required: - discussion_body_url secret-scanning-location-discussion-comment: description: >- Represents a 'discussion_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a discussion. type: object properties: discussion_comment_url: type: string format: uri description: >- The API URL to get the discussion comment where the secret was detected. example: >- https://github.com/community/community/discussions/39082#discussioncomment-4158232 required: - discussion_comment_url secret-scanning-location-pull-request-title: description: >- Represents a 'pull_request_title' secret scanning location type. This location type shows that a secret was detected in the title of a pull request. type: object properties: pull_request_title_url: type: string format: uri description: The API URL to get the pull request where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pull/2846 required: - pull_request_title_url secret-scanning-location-pull-request-body: description: >- Represents a 'pull_request_body' secret scanning location type. This location type shows that a secret was detected in the body of a pull request. type: object properties: pull_request_body_url: type: string format: uri description: The API URL to get the pull request where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pull/2846 required: - pull_request_body_url secret-scanning-location-pull-request-comment: description: >- Represents a 'pull_request_comment' secret scanning location type. This location type shows that a secret was detected in a comment on a pull request. type: object properties: pull_request_comment_url: type: string format: uri description: >- The API URL to get the pull request comment where the secret was detected. example: >- https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451 required: - pull_request_comment_url secret-scanning-location-pull-request-review: description: >- Represents a 'pull_request_review' secret scanning location type. This location type shows that a secret was detected in a review on a pull request. type: object properties: pull_request_review_url: type: string format: uri description: >- The API URL to get the pull request review where the secret was detected. example: >- https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80 required: - pull_request_review_url secret-scanning-location-pull-request-review-comment: description: >- Represents a 'pull_request_review_comment' secret scanning location type. This location type shows that a secret was detected in a review comment on a pull request. type: object properties: pull_request_review_comment_url: type: string format: uri description: >- The API URL to get the pull request review comment where the secret was detected. example: https://api.github.com/repos/octocat/Hello-World/pulls/comments/12 required: - pull_request_review_comment_url 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: title: Repository description: A repository on GitHub. type: object properties: id: description: Unique identifier of the repository example: 42 type: integer node_id: type: string example: MDEwOlJlcG9zaXRvcnkxMjk2MjY5 name: description: The name of the repository. type: string example: Team Environment full_name: type: string example: octocat/Hello-World license: $ref: '#/components/schemas/nullable-license-simple' forks: type: integer example: 42 permissions: type: object properties: admin: type: boolean pull: type: boolean triage: type: boolean push: type: boolean maintain: type: boolean required: - admin - pull - push owner: $ref: '#/components/schemas/simple-user' private: description: Whether the repository is private or public. default: false type: boolean example: true html_url: type: string format: uri example: https://github.com/octocat/Hello-World description: type: string example: This your first repo! nullable: true fork: type: boolean example: true url: type: string format: uri example: https://api.github.com/repos/octocat/Hello-World archive_url: type: string example: >- http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref} assignees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/assignees{/user} blobs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha} branches_url: type: string example: http://api.github.com/repos/octocat/Hello-World/branches{/branch} collaborators_url: type: string example: >- http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator} comments_url: type: string example: http://api.github.com/repos/octocat/Hello-World/comments{/number} commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/commits{/sha} compare_url: type: string example: >- http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head} contents_url: type: string example: http://api.github.com/repos/octocat/Hello-World/contents/{+path} contributors_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/contributors deployments_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/deployments downloads_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/downloads events_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/events forks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/forks git_commits_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/commits{/sha} git_refs_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/refs{/sha} git_tags_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/tags{/sha} git_url: type: string example: git:github.com/octocat/Hello-World.git issue_comment_url: type: string example: >- http://api.github.com/repos/octocat/Hello-World/issues/comments{/number} issue_events_url: type: string example: >- http://api.github.com/repos/octocat/Hello-World/issues/events{/number} issues_url: type: string example: http://api.github.com/repos/octocat/Hello-World/issues{/number} keys_url: type: string example: http://api.github.com/repos/octocat/Hello-World/keys{/key_id} labels_url: type: string example: http://api.github.com/repos/octocat/Hello-World/labels{/name} languages_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/languages merges_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/merges milestones_url: type: string example: http://api.github.com/repos/octocat/Hello-World/milestones{/number} notifications_url: type: string example: >- http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating} pulls_url: type: string example: http://api.github.com/repos/octocat/Hello-World/pulls{/number} releases_url: type: string example: http://api.github.com/repos/octocat/Hello-World/releases{/id} ssh_url: type: string example: git@github.com:octocat/Hello-World.git stargazers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/stargazers statuses_url: type: string example: http://api.github.com/repos/octocat/Hello-World/statuses/{sha} subscribers_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscribers subscription_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/subscription tags_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/tags teams_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/teams trees_url: type: string example: http://api.github.com/repos/octocat/Hello-World/git/trees{/sha} clone_url: type: string example: https://github.com/octocat/Hello-World.git mirror_url: type: string format: uri example: git:git.example.com/octocat/Hello-World nullable: true hooks_url: type: string format: uri example: http://api.github.com/repos/octocat/Hello-World/hooks svn_url: type: string format: uri example: https://svn.github.com/octocat/Hello-World homepage: type: string format: uri example: https://github.com nullable: true language: type: string nullable: true forks_count: type: integer example: 9 stargazers_count: type: integer example: 80 watchers_count: type: integer example: 80 size: description: >- The size of the repository, in kilobytes. Size is calculated hourly. When a repository is initially created, the size is 0. type: integer example: 108 default_branch: description: The default branch of the repository. type: string example: master open_issues_count: type: integer example: 0 is_template: description: >- Whether this repository acts as a template that can be used to generate new repositories. default: false type: boolean example: true topics: type: array items: type: string has_issues: description: Whether issues are enabled. default: true type: boolean example: true has_projects: description: Whether projects are enabled. default: true type: boolean example: true has_wiki: description: Whether the wiki is enabled. default: true type: boolean example: true has_pages: type: boolean has_downloads: description: Whether downloads are enabled. default: true type: boolean example: true deprecated: true has_discussions: description: Whether discussions are enabled. default: false type: boolean example: true archived: description: Whether the repository is archived. default: false type: boolean disabled: type: boolean description: Returns whether or not this repository disabled. visibility: description: 'The repository visibility: public, private, or internal.' default: public type: string pushed_at: type: string format: date-time example: '2011-01-26T19:06:43Z' nullable: true created_at: type: string format: date-time example: '2011-01-26T19:01:12Z' nullable: true updated_at: type: string format: date-time example: '2011-01-26T19:14:43Z' nullable: true allow_rebase_merge: description: Whether to allow rebase merges for pull requests. default: true type: boolean example: true temp_clone_token: type: string allow_squash_merge: description: Whether to allow squash merges for pull requests. default: true type: boolean example: true allow_auto_merge: description: Whether to allow Auto-merge to be used on pull requests. default: false type: boolean example: false delete_branch_on_merge: description: Whether to delete head branches when pull requests are merged default: false type: boolean example: false allow_update_branch: description: >- Whether or not a pull request head branch that is behind its base branch can always be updated even if it is not required to be up to date before merging. default: false type: boolean example: false use_squash_pr_title_as_default: type: boolean description: >- Whether a squash merge commit can use the pull request title as default. **This property has been deprecated. Please use `squash_merge_commit_title` instead. default: false deprecated: true squash_merge_commit_title: type: string enum: - PR_TITLE - COMMIT_OR_PR_TITLE description: >- The default value for a squash merge commit title: - `PR_TITLE` - default to the pull request's title. - `COMMIT_OR_PR_TITLE` - default to the commit's title (if only one commit) or the pull request's title (when more than one commit). squash_merge_commit_message: type: string enum: - PR_BODY - COMMIT_MESSAGES - BLANK description: |- The default value for a squash merge commit message: - `PR_BODY` - default to the pull request's body. - `COMMIT_MESSAGES` - default to the branch's commit messages. - `BLANK` - default to a blank commit message. merge_commit_title: type: string enum: - PR_TITLE - MERGE_MESSAGE description: >- The default value for a merge commit title. - `PR_TITLE` - default to the pull request's title. - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name). merge_commit_message: type: string enum: - PR_BODY - PR_TITLE - BLANK description: |- The default value for a merge commit message. - `PR_TITLE` - default to the pull request's title. - `PR_BODY` - default to the pull request's body. - `BLANK` - default to a blank commit message. allow_merge_commit: description: Whether to allow merge commits for pull requests. default: true type: boolean example: true allow_forking: description: Whether to allow forking this repo type: boolean web_commit_signoff_required: description: Whether to require contributors to sign off on web-based commits default: false type: boolean open_issues: type: integer watchers: type: integer master_branch: type: string starred_at: type: string example: '"2020-07-09T00:17:42Z"' anonymous_access_enabled: type: boolean description: Whether anonymous git access is enabled for this repository required: - archive_url - assignees_url - blobs_url - branches_url - collaborators_url - comments_url - commits_url - compare_url - contents_url - contributors_url - deployments_url - description - downloads_url - events_url - fork - forks_url - full_name - git_commits_url - git_refs_url - git_tags_url - hooks_url - html_url - id - node_id - issue_comment_url - issue_events_url - issues_url - keys_url - labels_url - languages_url - merges_url - milestones_url - name - notifications_url - owner - private - pulls_url - releases_url - stargazers_url - statuses_url - subscribers_url - subscription_url - tags_url - teams_url - trees_url - url - clone_url - default_branch - forks - forks_count - git_url - has_downloads - has_issues - has_projects - has_wiki - has_pages - homepage - language - archived - disabled - mirror_url - open_issues - open_issues_count - license - pushed_at - size - ssh_url - stargazers_count - svn_url - watchers - watchers_count - created_at - updated_at code-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 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 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' 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' 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 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 securitySchemes: bearerHttpAuthentication: description: Bearer Token type: http scheme: Bearer examples: code-of-conduct-simple-items: value: - key: citizen_code_of_conduct name: Citizen Code of Conduct url: https://api.github.com/codes_of_conduct/citizen_code_of_conduct html_url: http://citizencodeofconduct.org/ - key: contributor_covenant name: Contributor Covenant url: https://api.github.com/codes_of_conduct/contributor_covenant html_url: https://www.contributor-covenant.org/version/2/0/code_of_conduct/ code-of-conduct: value: key: contributor_covenant name: Contributor Covenant url: https://api.github.com/codes_of_conduct/contributor_covenant body: > # Contributor Covenant Code of Conduct ## Our Pledge In 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. ## Our Standards Examples of behavior that contributes to creating a positive environment include: * Using welcoming and inclusive language * Being respectful of differing viewpoints and experiences * Gracefully accepting constructive criticism * Focusing on what is best for the community * Showing empathy towards other community members Examples of unacceptable behavior by participants include: * The use of sexualized language or imagery and unwelcome sexual attention or advances * Trolling, insulting/derogatory comments, and personal or political attacks * Public or private harassment * Publishing others' private information, such as a physical or electronic address, without explicit permission * Other conduct which could reasonably be considered inappropriate in a professional setting ## Our Responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. Project 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. ## Scope This 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, 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. ## Enforcement Instances 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. Project 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. ## Attribution This 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/). html_url: http://contributor-covenant.org/version/1/4/ check-run-completed: value: action: completed check_run: id: 128620228 node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 external_id: '' url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 html_url: https://github.com/Codertocat/Hello-World/runs/128620228 details_url: https://octocoders.github.io status: completed conclusion: success started_at: '2019-05-15T15:21:12Z' completed_at: '2019-05-15T15:21:45Z' output: title: summary: text: annotations_count: 0 annotations_url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations name: Octocoders-linter check_suite: id: 118578147 node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= head_branch: changes head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 status: completed conclusion: url: >- https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World deployment: url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 id: 326191728 node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= task: deploy original_environment: lab environment: lab description: created_at: '2021-02-18T08:22:48Z' updated_at: '2021-02-18T09:47:16Z' statuses_url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses repository_url: https://api.github.com/repos/Codertocat/Hello-World app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' updated_at: '2019-05-15T15:20:31Z' app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World repository: id: 186853002 node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= name: Hello-World full_name: Codertocat/Hello-World private: false owner: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false html_url: https://github.com/Codertocat/Hello-World description: fork: false url: https://api.github.com/repos/Codertocat/Hello-World forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} collaborators_url: >- https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks issue_events_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} events_url: https://api.github.com/repos/Codertocat/Hello-World/events assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} branches_url: >- https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} git_commits_url: >- https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} comments_url: >- https://api.github.com/repos/Codertocat/Hello-World/comments{/number} issue_comment_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} compare_url: >- https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges archive_url: >- https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} milestones_url: >- https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} notifications_url: >- https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments created_at: '2019-05-15T15:19:25Z' updated_at: '2019-05-15T15:21:03Z' pushed_at: '2019-05-15T15:20:57Z' git_url: git://github.com/Codertocat/Hello-World.git ssh_url: git@github.com:Codertocat/Hello-World.git clone_url: https://github.com/Codertocat/Hello-World.git svn_url: https://github.com/Codertocat/Hello-World homepage: size: 0 stargazers_count: 0 watchers_count: 0 language: Ruby has_issues: true has_projects: true has_downloads: true has_wiki: true has_pages: true forks_count: 1 mirror_url: archived: false disabled: false open_issues_count: 2 license: forks: 1 open_issues: 2 watchers: 0 default_branch: master is_template: false sender: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false check-run-completed-form-encoded: value: payload: >- %7B%22action%22%3A%22completed%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D check-run-created: value: action: created check_run: id: 128620228 node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 external_id: '' url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 html_url: https://github.com/Codertocat/Hello-World/runs/128620228 details_url: https://octocoders.github.io status: queued conclusion: started_at: '2019-05-15T15:21:12Z' completed_at: output: title: summary: text: annotations_count: 0 annotations_url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations name: Octocoders-linter check_suite: id: 118578147 node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= head_branch: changes head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 status: queued conclusion: url: >- https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World deployment: url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 id: 326191728 node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= task: deploy original_environment: lab environment: lab description: created_at: '2021-02-18T08:22:48Z' updated_at: '2021-02-18T09:47:16Z' statuses_url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses repository_url: https://api.github.com/repos/Codertocat/Hello-World app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' updated_at: '2019-05-15T15:20:31Z' app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World repository: id: 186853002 node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= name: Hello-World full_name: Codertocat/Hello-World private: false owner: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false html_url: https://github.com/Codertocat/Hello-World description: fork: false url: https://api.github.com/repos/Codertocat/Hello-World forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} collaborators_url: >- https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks issue_events_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} events_url: https://api.github.com/repos/Codertocat/Hello-World/events assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} branches_url: >- https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} git_commits_url: >- https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} comments_url: >- https://api.github.com/repos/Codertocat/Hello-World/comments{/number} issue_comment_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} compare_url: >- https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges archive_url: >- https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} milestones_url: >- https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} notifications_url: >- https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments created_at: '2019-05-15T15:19:25Z' updated_at: '2019-05-15T15:21:03Z' pushed_at: '2019-05-15T15:20:57Z' git_url: git://github.com/Codertocat/Hello-World.git ssh_url: git@github.com:Codertocat/Hello-World.git clone_url: https://github.com/Codertocat/Hello-World.git svn_url: https://github.com/Codertocat/Hello-World homepage: size: 0 stargazers_count: 0 watchers_count: 0 language: Ruby has_issues: true has_projects: true has_downloads: true has_wiki: true has_pages: true forks_count: 1 mirror_url: archived: false disabled: false open_issues_count: 2 license: forks: 1 open_issues: 2 watchers: 0 default_branch: master is_template: false sender: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false check-run-created-form-encoded: value: payload: >- %7B%22action%22%3A%22created%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D check-run-requested-action: value: action: requested_action check_run: id: 128620228 node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 external_id: '' url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 html_url: https://github.com/Codertocat/Hello-World/runs/128620228 details_url: https://octocoders.github.io status: queued conclusion: started_at: '2019-05-15T15:21:12Z' completed_at: output: title: summary: text: annotations_count: 0 annotations_url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations name: Octocoders-linter check_suite: id: 118578147 node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= head_branch: changes head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 status: queued conclusion: url: >- https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' updated_at: '2019-05-15T15:20:31Z' app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World deployment: url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 id: 326191728 node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= task: deploy original_environment: lab environment: lab description: created_at: '2021-02-18T08:22:48Z' updated_at: '2021-02-18T09:47:16Z' statuses_url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses repository_url: https://api.github.com/repos/Codertocat/Hello-World requested_action: identifier: lgtm|1234 repository: id: 186853002 node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= name: Hello-World full_name: Codertocat/Hello-World private: false owner: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false html_url: https://github.com/Codertocat/Hello-World description: fork: false url: https://api.github.com/repos/Codertocat/Hello-World forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} collaborators_url: >- https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks issue_events_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} events_url: https://api.github.com/repos/Codertocat/Hello-World/events assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} branches_url: >- https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} git_commits_url: >- https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} comments_url: >- https://api.github.com/repos/Codertocat/Hello-World/comments{/number} issue_comment_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} compare_url: >- https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges archive_url: >- https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} milestones_url: >- https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} notifications_url: >- https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments created_at: '2019-05-15T15:19:25Z' updated_at: '2019-05-15T15:21:03Z' pushed_at: '2019-05-15T15:20:57Z' git_url: git://github.com/Codertocat/Hello-World.git ssh_url: git@github.com:Codertocat/Hello-World.git clone_url: https://github.com/Codertocat/Hello-World.git svn_url: https://github.com/Codertocat/Hello-World homepage: size: 0 stargazers_count: 0 watchers_count: 0 language: Ruby has_issues: true has_projects: true has_downloads: true has_wiki: true has_pages: true forks_count: 1 mirror_url: archived: false disabled: false open_issues_count: 2 license: forks: 1 open_issues: 2 watchers: 0 default_branch: master sender: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false check-run-requested-action-form-encoded: value: payload: >- %7B%22action%22%3A%22requested_action%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3Anull%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22queued%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%7D%2C%22requested_action%22%3A%7B%22identifier%22%3A%22lgtm%7C1234%22%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D check-run-rerequested: value: action: rerequested check_run: id: 128620228 node_id: MDg6Q2hlY2tSdW4xMjg2MjAyMjg= head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 external_id: '' url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228 html_url: https://github.com/Codertocat/Hello-World/runs/128620228 details_url: https://octocoders.github.io status: completed conclusion: success started_at: '2019-05-15T15:21:12Z' completed_at: '2019-05-15T15:21:45Z' output: title: summary: text: annotations_count: 0 annotations_url: >- https://api.github.com/repos/Codertocat/Hello-World/check-runs/128620228/annotations name: Octocoders-linter check_suite: id: 118578147 node_id: MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc= head_branch: changes head_sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 status: completed conclusion: url: >- https://api.github.com/repos/Codertocat/Hello-World/check-suites/118578147 before: 6113728f27ae82c7b1a177c8d03f9e96e0adf246 after: ec26c3e57ca3a959ca5aad62de7213c562f8c821 pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World deployment: url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728 id: 326191728 node_id: MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg= task: deploy original_environment: lab environment: lab description: created_at: '2021-02-18T08:22:48Z' updated_at: '2021-02-18T09:47:16Z' statuses_url: >- https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses repository_url: https://api.github.com/repos/Codertocat/Hello-World app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] created_at: '2019-05-15T15:20:31Z' updated_at: '2019-05-15T15:20:31Z' app: id: 29310 node_id: MDM6QXBwMjkzMTA= owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false name: octocoders-linter description: '' external_url: https://octocoders.github.io html_url: https://github.com/apps/octocoders-linter created_at: '2019-04-19T19:36:24Z' updated_at: '2019-04-19T19:36:56Z' permissions: administration: write checks: write contents: write deployments: write issues: write members: write metadata: read organization_administration: write organization_hooks: write organization_plan: read organization_projects: write organization_user_blocking: write pages: write pull_requests: write repository_hooks: write repository_projects: write statuses: write team_discussions: write vulnerability_alerts: read events: [] pull_requests: - url: https://api.github.com/repos/Codertocat/Hello-World/pulls/2 id: 279147437 number: 2 head: ref: changes sha: ec26c3e57ca3a959ca5aad62de7213c562f8c821 repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World base: ref: master sha: f95f852bd8fca8fcc58a9a2d6c842781e32a215e repo: id: 186853002 url: https://api.github.com/repos/Codertocat/Hello-World name: Hello-World repository: id: 186853002 node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= name: Hello-World full_name: Codertocat/Hello-World private: false owner: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false html_url: https://github.com/Codertocat/Hello-World description: fork: false url: https://api.github.com/repos/Codertocat/Hello-World forks_url: https://api.github.com/repos/Codertocat/Hello-World/forks keys_url: https://api.github.com/repos/Codertocat/Hello-World/keys{/key_id} collaborators_url: >- https://api.github.com/repos/Codertocat/Hello-World/collaborators{/collaborator} teams_url: https://api.github.com/repos/Codertocat/Hello-World/teams hooks_url: https://api.github.com/repos/Codertocat/Hello-World/hooks issue_events_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/events{/number} events_url: https://api.github.com/repos/Codertocat/Hello-World/events assignees_url: https://api.github.com/repos/Codertocat/Hello-World/assignees{/user} branches_url: >- https://api.github.com/repos/Codertocat/Hello-World/branches{/branch} tags_url: https://api.github.com/repos/Codertocat/Hello-World/tags blobs_url: https://api.github.com/repos/Codertocat/Hello-World/git/blobs{/sha} git_tags_url: https://api.github.com/repos/Codertocat/Hello-World/git/tags{/sha} git_refs_url: https://api.github.com/repos/Codertocat/Hello-World/git/refs{/sha} trees_url: https://api.github.com/repos/Codertocat/Hello-World/git/trees{/sha} statuses_url: https://api.github.com/repos/Codertocat/Hello-World/statuses/{sha} languages_url: https://api.github.com/repos/Codertocat/Hello-World/languages stargazers_url: https://api.github.com/repos/Codertocat/Hello-World/stargazers contributors_url: https://api.github.com/repos/Codertocat/Hello-World/contributors subscribers_url: https://api.github.com/repos/Codertocat/Hello-World/subscribers subscription_url: https://api.github.com/repos/Codertocat/Hello-World/subscription commits_url: https://api.github.com/repos/Codertocat/Hello-World/commits{/sha} git_commits_url: >- https://api.github.com/repos/Codertocat/Hello-World/git/commits{/sha} comments_url: >- https://api.github.com/repos/Codertocat/Hello-World/comments{/number} issue_comment_url: >- https://api.github.com/repos/Codertocat/Hello-World/issues/comments{/number} contents_url: https://api.github.com/repos/Codertocat/Hello-World/contents/{+path} compare_url: >- https://api.github.com/repos/Codertocat/Hello-World/compare/{base}...{head} merges_url: https://api.github.com/repos/Codertocat/Hello-World/merges archive_url: >- https://api.github.com/repos/Codertocat/Hello-World/{archive_format}{/ref} downloads_url: https://api.github.com/repos/Codertocat/Hello-World/downloads issues_url: https://api.github.com/repos/Codertocat/Hello-World/issues{/number} pulls_url: https://api.github.com/repos/Codertocat/Hello-World/pulls{/number} milestones_url: >- https://api.github.com/repos/Codertocat/Hello-World/milestones{/number} notifications_url: >- https://api.github.com/repos/Codertocat/Hello-World/notifications{?since,all,participating} labels_url: https://api.github.com/repos/Codertocat/Hello-World/labels{/name} releases_url: https://api.github.com/repos/Codertocat/Hello-World/releases{/id} deployments_url: https://api.github.com/repos/Codertocat/Hello-World/deployments created_at: '2019-05-15T15:19:25Z' updated_at: '2019-05-15T15:21:03Z' pushed_at: '2019-05-15T15:20:57Z' git_url: git://github.com/Codertocat/Hello-World.git ssh_url: git@github.com:Codertocat/Hello-World.git clone_url: https://github.com/Codertocat/Hello-World.git svn_url: https://github.com/Codertocat/Hello-World homepage: size: 0 stargazers_count: 0 watchers_count: 0 language: Ruby has_issues: true has_projects: true has_downloads: true has_wiki: true has_pages: true forks_count: 1 mirror_url: archived: false disabled: false open_issues_count: 2 license: forks: 1 open_issues: 2 watchers: 0 default_branch: master is_template: false sender: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false check-run-rerequested-form-encoded: value: payload: >- %7B%22action%22%3A%22rerequested%22%2C%22check_run%22%3A%7B%22id%22%3A128620228%2C%22node_id%22%3A%22MDg6Q2hlY2tSdW4xMjg2MjAyMjg%3D%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22external_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%2Fruns%2F128620228%22%2C%22details_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3A%22success%22%2C%22started_at%22%3A%222019-05-15T15%3A21%3A12Z%22%2C%22completed_at%22%3A%222019-05-15T15%3A21%3A45Z%22%2C%22output%22%3A%7B%22title%22%3Anull%2C%22summary%22%3Anull%2C%22text%22%3Anull%2C%22annotations_count%22%3A0%2C%22annotations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-runs%2F128620228%2Fannotations%22%7D%2C%22name%22%3A%22Octocoders-linter%22%2C%22check_suite%22%3A%7B%22id%22%3A118578147%2C%22node_id%22%3A%22MDEwOkNoZWNrU3VpdGUxMTg1NzgxNDc%3D%22%2C%22head_branch%22%3A%22changes%22%2C%22head_sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22status%22%3A%22completed%22%2C%22conclusion%22%3Anull%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcheck-suites%2F118578147%22%2C%22before%22%3A%226113728f27ae82c7b1a177c8d03f9e96e0adf246%22%2C%22after%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%2C%22deployment%22%3A%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%22%2C%22id%22%3A326191728%2C%22node_id%22%3A%22MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg%3D%22%2C%22task%22%3A%22deploy%22%2C%22original_environment%22%3A%22lab%22%2C%22environment%22%3A%22lab%22%2C%22description%22%3Anull%2C%22created_at%22%3A%222021-02-18T08%3A22%3A48Z%22%2C%22updated_at%22%3A%222021-02-18T09%3A47%3A16Z%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%2F326191728%2Fstatuses%22%2C%22repository_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22created_at%22%3A%222019-05-15T15%3A20%3A31Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A20%3A31Z%22%7D%2C%22app%22%3A%7B%22id%22%3A29310%2C%22node_id%22%3A%22MDM6QXBwMjkzMTA%3D%22%2C%22owner%22%3A%7B%22login%22%3A%22Octocoders%22%2C%22id%22%3A38302899%2C%22node_id%22%3A%22MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F38302899%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FOctocoders%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FOctocoders%2Freceived_events%22%2C%22type%22%3A%22Organization%22%2C%22site_admin%22%3Afalse%7D%2C%22name%22%3A%22octocoders-linter%22%2C%22description%22%3A%22%22%2C%22external_url%22%3A%22https%3A%2F%2Foctocoders.github.io%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Fapps%2Foctocoders-linter%22%2C%22created_at%22%3A%222019-04-19T19%3A36%3A24Z%22%2C%22updated_at%22%3A%222019-04-19T19%3A36%3A56Z%22%2C%22permissions%22%3A%7B%22administration%22%3A%22write%22%2C%22checks%22%3A%22write%22%2C%22contents%22%3A%22write%22%2C%22deployments%22%3A%22write%22%2C%22issues%22%3A%22write%22%2C%22members%22%3A%22write%22%2C%22metadata%22%3A%22read%22%2C%22organization_administration%22%3A%22write%22%2C%22organization_hooks%22%3A%22write%22%2C%22organization_plan%22%3A%22read%22%2C%22organization_projects%22%3A%22write%22%2C%22organization_user_blocking%22%3A%22write%22%2C%22pages%22%3A%22write%22%2C%22pull_requests%22%3A%22write%22%2C%22repository_hooks%22%3A%22write%22%2C%22repository_projects%22%3A%22write%22%2C%22statuses%22%3A%22write%22%2C%22team_discussions%22%3A%22write%22%2C%22vulnerability_alerts%22%3A%22read%22%7D%2C%22events%22%3A%5B%5D%7D%2C%22pull_requests%22%3A%5B%7B%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%2F2%22%2C%22id%22%3A279147437%2C%22number%22%3A2%2C%22head%22%3A%7B%22ref%22%3A%22changes%22%2C%22sha%22%3A%22ec26c3e57ca3a959ca5aad62de7213c562f8c821%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%2C%22base%22%3A%7B%22ref%22%3A%22master%22%2C%22sha%22%3A%22f95f852bd8fca8fcc58a9a2d6c842781e32a215e%22%2C%22repo%22%3A%7B%22id%22%3A186853002%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22name%22%3A%22Hello-World%22%7D%7D%7D%5D%7D%2C%22repository%22%3A%7B%22id%22%3A186853002%2C%22node_id%22%3A%22MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%22%2C%22name%22%3A%22Hello-World%22%2C%22full_name%22%3A%22Codertocat%2FHello-World%22%2C%22private%22%3Afalse%2C%22owner%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22description%22%3Anull%2C%22fork%22%3Afalse%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%22%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fforks%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fkeys%7B%2Fkey_id%7D%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fteams%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fhooks%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fevents%22%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fassignees%7B%2Fuser%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fbranches%7B%2Fbranch%7D%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Ftags%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstatuses%2F%7Bsha%7D%22%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flanguages%22%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fstargazers%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontributors%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fsubscription%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcommits%7B%2Fsha%7D%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcontents%2F%7B%2Bpath%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmerges%22%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdownloads%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fissues%7B%2Fnumber%7D%22%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fpulls%7B%2Fnumber%7D%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fmilestones%7B%2Fnumber%7D%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Flabels%7B%2Fname%7D%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Freleases%7B%2Fid%7D%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2FCodertocat%2FHello-World%2Fdeployments%22%2C%22created_at%22%3A%222019-05-15T15%3A19%3A25Z%22%2C%22updated_at%22%3A%222019-05-15T15%3A21%3A03Z%22%2C%22pushed_at%22%3A%222019-05-15T15%3A20%3A57Z%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22ssh_url%22%3A%22git%40github.com%3ACodertocat%2FHello-World.git%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World.git%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%2FHello-World%22%2C%22homepage%22%3Anull%2C%22size%22%3A0%2C%22stargazers_count%22%3A0%2C%22watchers_count%22%3A0%2C%22language%22%3A%22Ruby%22%2C%22has_issues%22%3Atrue%2C%22has_projects%22%3Atrue%2C%22has_downloads%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22has_pages%22%3Atrue%2C%22forks_count%22%3A1%2C%22mirror_url%22%3Anull%2C%22archived%22%3Afalse%2C%22disabled%22%3Afalse%2C%22open_issues_count%22%3A2%2C%22license%22%3Anull%2C%22forks%22%3A1%2C%22open_issues%22%3A2%2C%22watchers%22%3A0%2C%22default_branch%22%3A%22master%22%2C%22is_template%22%3Afalse%7D%2C%22sender%22%3A%7B%22login%22%3A%22Codertocat%22%2C%22id%22%3A21031067%2C%22node_id%22%3A%22MDQ6VXNlcjIxMDMxMDY3%22%2C%22avatar_url%22%3A%22https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%22%2C%22gravatar_id%22%3A%22%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2FCodertocat%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fgists%7B%2Fgist_id%7D%22%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fsubscriptions%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Forgs%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Frepos%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Fevents%7B%2Fprivacy%7D%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2FCodertocat%2Freceived_events%22%2C%22type%22%3A%22User%22%2C%22site_admin%22%3Afalse%7D%7D ping: value: zen: Anything added dilutes everything else. hook_id: 109948940 hook: type: Repository id: 109948940 name: web active: true events: - '*' config: content_type: json url: https://smee.io/**************** insecure_ssl: '0' updated_at: '2019-05-15T15:20:49Z' created_at: '2019-05-15T15:20:49Z' url: https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940 test_url: >- https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/test ping_url: >- https://api.github.com/repos/Octocoders/Hello-World/hooks/109948940/pings last_response: code: status: unused message: repository: id: 186853261 node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMyNjE= name: Hello-World full_name: Octocoders/Hello-World private: false owner: login: Octocoders id: 38302899 node_id: MDEyOk9yZ2FuaXphdGlvbjM4MzAyODk5 avatar_url: https://avatars1.githubusercontent.com/u/38302899?v=4 gravatar_id: '' url: https://api.github.com/users/Octocoders html_url: https://github.com/Octocoders followers_url: https://api.github.com/users/Octocoders/followers following_url: https://api.github.com/users/Octocoders/following{/other_user} gists_url: https://api.github.com/users/Octocoders/gists{/gist_id} starred_url: https://api.github.com/users/Octocoders/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Octocoders/subscriptions organizations_url: https://api.github.com/users/Octocoders/orgs repos_url: https://api.github.com/users/Octocoders/repos events_url: https://api.github.com/users/Octocoders/events{/privacy} received_events_url: https://api.github.com/users/Octocoders/received_events type: Organization site_admin: false html_url: https://github.com/Octocoders/Hello-World description: fork: true url: https://api.github.com/repos/Octocoders/Hello-World forks_url: https://api.github.com/repos/Octocoders/Hello-World/forks keys_url: https://api.github.com/repos/Octocoders/Hello-World/keys{/key_id} collaborators_url: >- https://api.github.com/repos/Octocoders/Hello-World/collaborators{/collaborator} teams_url: https://api.github.com/repos/Octocoders/Hello-World/teams hooks_url: https://api.github.com/repos/Octocoders/Hello-World/hooks issue_events_url: >- https://api.github.com/repos/Octocoders/Hello-World/issues/events{/number} events_url: https://api.github.com/repos/Octocoders/Hello-World/events assignees_url: https://api.github.com/repos/Octocoders/Hello-World/assignees{/user} branches_url: >- https://api.github.com/repos/Octocoders/Hello-World/branches{/branch} tags_url: https://api.github.com/repos/Octocoders/Hello-World/tags blobs_url: https://api.github.com/repos/Octocoders/Hello-World/git/blobs{/sha} git_tags_url: https://api.github.com/repos/Octocoders/Hello-World/git/tags{/sha} git_refs_url: https://api.github.com/repos/Octocoders/Hello-World/git/refs{/sha} trees_url: https://api.github.com/repos/Octocoders/Hello-World/git/trees{/sha} statuses_url: https://api.github.com/repos/Octocoders/Hello-World/statuses/{sha} languages_url: https://api.github.com/repos/Octocoders/Hello-World/languages stargazers_url: https://api.github.com/repos/Octocoders/Hello-World/stargazers contributors_url: https://api.github.com/repos/Octocoders/Hello-World/contributors subscribers_url: https://api.github.com/repos/Octocoders/Hello-World/subscribers subscription_url: https://api.github.com/repos/Octocoders/Hello-World/subscription commits_url: https://api.github.com/repos/Octocoders/Hello-World/commits{/sha} git_commits_url: >- https://api.github.com/repos/Octocoders/Hello-World/git/commits{/sha} comments_url: >- https://api.github.com/repos/Octocoders/Hello-World/comments{/number} issue_comment_url: >- https://api.github.com/repos/Octocoders/Hello-World/issues/comments{/number} contents_url: https://api.github.com/repos/Octocoders/Hello-World/contents/{+path} compare_url: >- https://api.github.com/repos/Octocoders/Hello-World/compare/{base}...{head} merges_url: https://api.github.com/repos/Octocoders/Hello-World/merges archive_url: >- https://api.github.com/repos/Octocoders/Hello-World/{archive_format}{/ref} downloads_url: https://api.github.com/repos/Octocoders/Hello-World/downloads issues_url: https://api.github.com/repos/Octocoders/Hello-World/issues{/number} pulls_url: https://api.github.com/repos/Octocoders/Hello-World/pulls{/number} milestones_url: >- https://api.github.com/repos/Octocoders/Hello-World/milestones{/number} notifications_url: >- https://api.github.com/repos/Octocoders/Hello-World/notifications{?since,all,participating} labels_url: https://api.github.com/repos/Octocoders/Hello-World/labels{/name} releases_url: https://api.github.com/repos/Octocoders/Hello-World/releases{/id} deployments_url: https://api.github.com/repos/Octocoders/Hello-World/deployments created_at: '2019-05-15T15:20:42Z' updated_at: '2019-05-15T15:20:45Z' pushed_at: '2019-05-15T15:20:33Z' git_url: git://github.com/Octocoders/Hello-World.git ssh_url: git@github.com:Octocoders/Hello-World.git clone_url: https://github.com/Octocoders/Hello-World.git svn_url: https://github.com/Octocoders/Hello-World homepage: size: 0 stargazers_count: 0 watchers_count: 0 language: Ruby has_issues: false has_projects: true has_downloads: true has_wiki: true has_pages: false forks_count: 0 mirror_url: archived: false disabled: false open_issues_count: 0 license: forks: 0 open_issues: 0 watchers: 0 default_branch: master sender: login: Codertocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?v=4 gravatar_id: '' url: https://api.github.com/users/Codertocat html_url: https://github.com/Codertocat followers_url: https://api.github.com/users/Codertocat/followers following_url: https://api.github.com/users/Codertocat/following{/other_user} gists_url: https://api.github.com/users/Codertocat/gists{/gist_id} starred_url: https://api.github.com/users/Codertocat/starred{/owner}{/repo} subscriptions_url: https://api.github.com/users/Codertocat/subscriptions organizations_url: https://api.github.com/users/Codertocat/orgs repos_url: https://api.github.com/users/Codertocat/repos events_url: https://api.github.com/users/Codertocat/events{/privacy} received_events_url: https://api.github.com/users/Codertocat/received_events type: User site_admin: false ping-form-encoded: value: payload: >- %7B%22hook%22%3A%7B%22active%22%3Atrue%2C%22config%22%3A%7B%22content_type%22%3A%22form%22%2C%22insecure_ssl%22%3A%220%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22created_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22deliveries_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fdeliveries%22%2C%22events%22%3A%5B%22%2A%22%5D%2C%22id%22%3A1234%2C%22last_response%22%3A%7B%22code%22%3Anull%2C%22message%22%3Anull%2C%22status%22%3A%22unused%22%7D%2C%22name%22%3A%22web%22%2C%22ping_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Fpings%22%2C%22test_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%2Ftest%22%2C%22type%22%3A%22Repository%22%2C%22updated_at%22%3A%222021-10-20T16%3A01%3A58Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%2F1234%22%7D%2C%22hook_id%22%3A1234%2C%22meta%22%3A%7B%22signed_at%22%3A%222021-10-25T19%3A05%3A13%2B00%3A00%22%2C%22event%22%3A%22ping%22%2C%22nonce%22%3A%221231%22%2C%22url%22%3A%22https%3A%2F%2Ftest.io%2Fform%22%7D%2C%22repository%22%3A%7B%22allow_forking%22%3Atrue%2C%22archive_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2F%7Barchive_format%7D%7B%2Fref%7D%22%2C%22archived%22%3Afalse%2C%22assignees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fassignees%7B%2Fuser%7D%22%2C%22blobs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fblobs%7B%2Fsha%7D%22%2C%22branches_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fbranches%7B%2Fbranch%7D%22%2C%22clone_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22collaborators_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcollaborators%7B%2Fcollaborator%7D%22%2C%22comments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcomments%7B%2Fnumber%7D%22%2C%22commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcommits%7B%2Fsha%7D%22%2C%22compare_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%22%2C%22contents_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontents%2F%7B%2Bpath%7D%22%2C%22contributors_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fcontributors%22%2C%22created_at%22%3A%222016-12-07T19%3A17%3A19Z%22%2C%22default_branch%22%3A%22master%22%2C%22deployments_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdeployments%22%2C%22description%22%3A%22A%2Btest%2Brepository%2Bfor%2Btest%2B.%22%2C%22disabled%22%3Afalse%2C%22downloads_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fdownloads%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fevents%22%2C%22fork%22%3Afalse%2C%22forks%22%3A0%2C%22forks_count%22%3A0%2C%22forks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fforks%22%2C%22full_name%22%3A%22testorg%2Ftestrepo%22%2C%22git_commits_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Fcommits%7B%2Fsha%7D%22%2C%22git_refs_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Frefs%7B%2Fsha%7D%22%2C%22git_tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftags%7B%2Fsha%7D%22%2C%22git_url%22%3A%22git%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo.git%22%2C%22has_downloads%22%3Atrue%2C%22has_issues%22%3Atrue%2C%22has_pages%22%3Afalse%2C%22has_projects%22%3Atrue%2C%22has_wiki%22%3Atrue%2C%22homepage%22%3A%22%22%2C%22hooks_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fhooks%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22id%22%3A4567%2C%22is_template%22%3Afalse%2C%22issue_comment_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fcomments%7B%2Fnumber%7D%22%2C%22issue_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%2Fevents%7B%2Fnumber%7D%22%2C%22issues_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fissues%7B%2Fnumber%7D%22%2C%22keys_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fkeys%7B%2Fkey_id%7D%22%2C%22labels_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flabels%7B%2Fname%7D%22%2C%22language%22%3Anull%2C%22languages_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Flanguages%22%2C%22license%22%3Anull%2C%22merges_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmerges%22%2C%22milestones_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fmilestones%7B%2Fnumber%7D%22%2C%22mirror_url%22%3Anull%2C%22name%22%3A%22testrepo%22%2C%22node_id%22%3A%22abcd%22%2C%22notifications_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%22%2C%22open_issues%22%3A27%2C%22open_issues_count%22%3A27%2C%22owner%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1231%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%22%2C%22id%22%3A4312013%2C%22login%22%3A%22testorg%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Frepos%22%2C%22site_admin%22%3Afalse%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%2Fsubscriptions%22%2C%22type%22%3A%22Organization%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestorg%22%7D%2C%22private%22%3Atrue%2C%22pulls_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fpulls%7B%2Fnumber%7D%22%2C%22pushed_at%22%3A%222021-10-08T17%3A33%3A23Z%22%2C%22releases_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Freleases%7B%2Fid%7D%22%2C%22size%22%3A43%2C%22ssh_url%22%3A%22git%40github.com%3Atestorg%2Ftestrepo.git%22%2C%22stargazers_count%22%3A1%2C%22stargazers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstargazers%22%2C%22statuses_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fstatuses%2F%7Bsha%7D%22%2C%22subscribers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscribers%22%2C%22subscription_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fsubscription%22%2C%22svn_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestorg%2Ftestrepo%22%2C%22tags_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Ftags%22%2C%22teams_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fteams%22%2C%22topics%22%3A%5B%5D%2C%22trees_url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%2Fgit%2Ftrees%7B%2Fsha%7D%22%2C%22updated_at%22%3A%222021-10-08T17%3A33%3A26Z%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Frepos%2Ftestorg%2Ftestrepo%22%2C%22visibility%22%3A%22private%22%2C%22watchers%22%3A1%2C%22watchers_count%22%3A1%7D%2C%22sender%22%3A%7B%22avatar_url%22%3A%22https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F1385175%3Fv%3D4%22%2C%22events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fevents%7B%2Fprivacy%7D%22%2C%22followers_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowers%22%2C%22following_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Ffollowing%7B%2Fother_user%7D%22%2C%22gists_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fgists%7B%2Fgist_id%7D%22%2C%22gravatar_id%22%3A%22%22%2C%22html_url%22%3A%22https%3A%2F%2Fgithub.com%2Ftestuser%22%2C%22id%22%3A1385175%2C%22login%22%3A%22testuser%22%2C%22node_id%22%3A%22abcd%22%2C%22organizations_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Forgs%22%2C%22received_events_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Freceived_events%22%2C%22repos_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Frepos%22%2C%22site_admin%22%3Atrue%2C%22starred_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%22%2C%22subscriptions_url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%2Fsubscriptions%22%2C%22type%22%3A%22User%22%2C%22url%22%3A%22https%3A%2F%2Fapi.github.com%2Fusers%2Ftestuser%22%7D%2C%22zen%22%3A%22Responsive%2Bis%2Bbetter%2Bthan%2Bfast.%22%7D secret-scanning-alert-location-created: value: action: created alert: number: 42 created_at: '2020-11-06T18:18:30Z' updated_at: '2020-11-06T18:18:30Z' url: >- https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42 html_url: >- https://github.com/octocat-repo/hello-world/security/secret-scanning/42 locations_url: >- https://api.github.com/repos/octocat-repo/hello-world/secret-scanning/alerts/42/locations state: open resolution: resolved_at: resolved_by: secret_type: mailchimp_api_key secret: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2 location: type: commit details: path: /example/secrets.txt start_line: 1 end_line: 1 start_column: 1 end_column: 64 blob_sha: af5626b4a114abcb82d63db7c8082c3c4756e51b blob_url: >- https://api.github.com/repos/octocat-repo/hello-world/git/blobs/af5626b4a114abcb82d63db7c8082c3c4756e51b commit_sha: f14d7debf9775f957cf4f1e8176da0786431f72b commit_url: >- https://api.github.com/repos/octocat-repo/hello-world/git/commits/f14d7debf9775f957cf4f1e8176da0786431f72b repository: id: 186853002 node_id: MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI= name: hello-world full_name: octocat-repo/hello-world private: false owner: login: octocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?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: false html_url: https://github.com/octocat-repo/hello-world description: fork: false url: https://api.github.com/repos/octocat-repo/hello-world forks_url: https://api.github.com/repos/octocat-repo/hello-world/forks keys_url: https://api.github.com/repos/octocat-repo/hello-world/keys{/key_id} collaborators_url: >- https://api.github.com/repos/octocat-repo/hello-world/collaborators{/collaborator} teams_url: https://api.github.com/repos/octocat-repo/hello-world/teams hooks_url: https://api.github.com/repos/octocat-repo/hello-world/hooks issue_events_url: >- https://api.github.com/repos/octocat-repo/hello-world/issues/events{/number} events_url: https://api.github.com/repos/octocat-repo/hello-world/events assignees_url: >- https://api.github.com/repos/octocat-repo/hello-world/assignees{/user} branches_url: >- https://api.github.com/repos/octocat-repo/hello-world/branches{/branch} tags_url: https://api.github.com/repos/octocat-repo/hello-world/tags blobs_url: >- https://api.github.com/repos/octocat-repo/hello-world/git/blobs{/sha} git_tags_url: https://api.github.com/repos/octocat-repo/hello-world/git/tags{/sha} git_refs_url: https://api.github.com/repos/octocat-repo/hello-world/git/refs{/sha} trees_url: >- https://api.github.com/repos/octocat-repo/hello-world/git/trees{/sha} statuses_url: https://api.github.com/repos/octocat-repo/hello-world/statuses/{sha} languages_url: https://api.github.com/repos/octocat-repo/hello-world/languages stargazers_url: https://api.github.com/repos/octocat-repo/hello-world/stargazers contributors_url: https://api.github.com/repos/octocat-repo/hello-world/contributors subscribers_url: https://api.github.com/repos/octocat-repo/hello-world/subscribers subscription_url: https://api.github.com/repos/octocat-repo/hello-world/subscription commits_url: https://api.github.com/repos/octocat-repo/hello-world/commits{/sha} git_commits_url: >- https://api.github.com/repos/octocat-repo/hello-world/git/commits{/sha} comments_url: >- https://api.github.com/repos/octocat-repo/hello-world/comments{/number} issue_comment_url: >- https://api.github.com/repos/octocat-repo/hello-world/issues/comments{/number} contents_url: >- https://api.github.com/repos/octocat-repo/hello-world/contents/{+path} compare_url: >- https://api.github.com/repos/octocat-repo/hello-world/compare/{base}...{head} merges_url: https://api.github.com/repos/octocat-repo/hello-world/merges archive_url: >- https://api.github.com/repos/octocat-repo/hello-world/{archive_format}{/ref} downloads_url: https://api.github.com/repos/octocat-repo/hello-world/downloads issues_url: >- https://api.github.com/repos/octocat-repo/hello-world/issues{/number} pulls_url: https://api.github.com/repos/octocat-repo/hello-world/pulls{/number} milestones_url: >- https://api.github.com/repos/octocat-repo/hello-world/milestones{/number} notifications_url: >- https://api.github.com/repos/octocat-repo/hello-world/notifications{?since,all,participating} labels_url: https://api.github.com/repos/octocat-repo/hello-world/labels{/name} releases_url: https://api.github.com/repos/octocat-repo/hello-world/releases{/id} deployments_url: https://api.github.com/repos/octocat-repo/hello-world/deployments created_at: '2019-05-15T15:19:25Z' updated_at: '2019-05-15T15:21:03Z' pushed_at: '2019-05-15T15:20:57Z' git_url: git://github.com/octocat-repo/hello-world.git ssh_url: git@github.com:octocat-repo/hello-world.git clone_url: https://github.com/octocat-repo/hello-world.git svn_url: https://github.com/octocat-repo/hello-world homepage: size: 0 stargazers_count: 0 watchers_count: 0 language: Ruby has_issues: true has_projects: true has_downloads: true has_wiki: true has_pages: true forks_count: 1 mirror_url: archived: false disabled: false open_issues_count: 2 license: forks: 1 open_issues: 2 watchers: 0 default_branch: master is_template: false sender: login: octocat id: 21031067 node_id: MDQ6VXNlcjIxMDMxMDY3 avatar_url: https://avatars1.githubusercontent.com/u/21031067?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: false secret-scanning-alert-location-created-form-encoded: value: payload: >- action%3A%20created%0A%20%20alert%3A%0A%20%20%20%20number%3A%2042%0A%20%20%20%20created_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20updated_at%3A%20%272020-11-06T18%3A18%3A30Z%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%2Fsecurity%2Fsecret-scanning%2F42%0A%20%20%20%20locations_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsecret-scanning%2Falerts%2F42%2Flocations%0A%20%20%20%20state%3A%20open%0A%20%20%20%20resolution%3A%20null%0A%20%20%20%20resolved_at%3A%20null%0A%20%20%20%20resolved_by%3A%20null%0A%20%20%20%20secret_type%3A%20mailchimp_api_key%0A%20%20%20%20secret%3A%20XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2%0A%20%20location%3A%0A%20%20%20%20type%3A%20commit%0A%20%20%20%20details%3A%0A%20%20%20%20%20%20path%3A%20%27%2Fexample%2Fsecrets.txt%27%0A%20%20%20%20%20%20start_line%3A%201%0A%20%20%20%20%20%20end_line%3A%201%0A%20%20%20%20%20%20start_column%3A%201%0A%20%20%20%20%20%20end_column%3A%2064%0A%20%20%20%20%20%20blob_sha%3A%20af5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20blob_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%2Faf5626b4a114abcb82d63db7c8082c3c4756e51b%0A%20%20%20%20%20%20commit_sha%3A%20f14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20%20%20%20%20commit_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%2Ff14d7debf9775f957cf4f1e8176da0786431f72b%0A%20%20repository%3A%0A%20%20%20%20id%3A%20186853002%0A%20%20%20%20node_id%3A%20MDEwOlJlcG9zaXRvcnkxODY4NTMwMDI%3D%0A%20%20%20%20name%3A%20hello-world%0A%20%20%20%20full_name%3A%20octocat-repo%2Fhello-world%0A%20%20%20%20private%3A%20false%0A%20%20%20%20owner%3A%0A%20%20%20%20%20%20login%3A%20octocat%0A%20%20%20%20%20%20id%3A%2021031067%0A%20%20%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20%20%20type%3A%20User%0A%20%20%20%20%20%20site_admin%3A%20false%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20description%3A%0A%20%20%20%20fork%3A%20false%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%0A%20%20%20%20forks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fforks%0A%20%20%20%20keys_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fkeys%7B%2Fkey_id%7D%0A%20%20%20%20collaborators_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcollaborators%7B%2Fcollaborator%7D%0A%20%20%20%20teams_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fteams%0A%20%20%20%20hooks_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fhooks%0A%20%20%20%20issue_events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fevents%7B%2Fnumber%7D%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fevents%0A%20%20%20%20assignees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fassignees%7B%2Fuser%7D%0A%20%20%20%20branches_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fbranches%7B%2Fbranch%7D%0A%20%20%20%20tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Ftags%0A%20%20%20%20blobs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fblobs%7B%2Fsha%7D%0A%20%20%20%20git_tags_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftags%7B%2Fsha%7D%0A%20%20%20%20git_refs_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Frefs%7B%2Fsha%7D%0A%20%20%20%20trees_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Ftrees%7B%2Fsha%7D%0A%20%20%20%20statuses_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstatuses%2F%7Bsha%7D%0A%20%20%20%20languages_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flanguages%0A%20%20%20%20stargazers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fstargazers%0A%20%20%20%20contributors_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontributors%0A%20%20%20%20subscribers_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscribers%0A%20%20%20%20subscription_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fsubscription%0A%20%20%20%20commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20git_commits_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fgit%2Fcommits%7B%2Fsha%7D%0A%20%20%20%20comments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20issue_comment_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%2Fcomments%7B%2Fnumber%7D%0A%20%20%20%20contents_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcontents%2F%7B%2Bpath%7D%0A%20%20%20%20compare_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fcompare%2F%7Bbase%7D...%7Bhead%7D%0A%20%20%20%20merges_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmerges%0A%20%20%20%20archive_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2F%7Barchive_format%7D%7B%2Fref%7D%0A%20%20%20%20downloads_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdownloads%0A%20%20%20%20issues_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fissues%7B%2Fnumber%7D%0A%20%20%20%20pulls_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fpulls%7B%2Fnumber%7D%0A%20%20%20%20milestones_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fmilestones%7B%2Fnumber%7D%0A%20%20%20%20notifications_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fnotifications%7B%3Fsince%2Call%2Cparticipating%7D%0A%20%20%20%20labels_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Flabels%7B%2Fname%7D%0A%20%20%20%20releases_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Freleases%7B%2Fid%7D%0A%20%20%20%20deployments_url%3A%20https%3A%2F%2Fapi.github.com%2Frepos%2Foctocat-repo%2Fhello-world%2Fdeployments%0A%20%20%20%20created_at%3A%20%272019-05-15T15%3A19%3A25Z%27%0A%20%20%20%20updated_at%3A%20%272019-05-15T15%3A21%3A03Z%27%0A%20%20%20%20pushed_at%3A%20%272019-05-15T15%3A20%3A57Z%27%0A%20%20%20%20git_url%3A%20git%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20ssh_url%3A%20git%40github.com%3Aoctocat-repo%2Fhello-world.git%0A%20%20%20%20clone_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world.git%0A%20%20%20%20svn_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat-repo%2Fhello-world%0A%20%20%20%20homepage%3A%0A%20%20%20%20size%3A%200%0A%20%20%20%20stargazers_count%3A%200%0A%20%20%20%20watchers_count%3A%200%0A%20%20%20%20language%3A%20Ruby%0A%20%20%20%20has_issues%3A%20true%0A%20%20%20%20has_projects%3A%20true%0A%20%20%20%20has_downloads%3A%20true%0A%20%20%20%20has_wiki%3A%20true%0A%20%20%20%20has_pages%3A%20true%0A%20%20%20%20forks_count%3A%201%0A%20%20%20%20mirror_url%3A%0A%20%20%20%20archived%3A%20false%0A%20%20%20%20disabled%3A%20false%0A%20%20%20%20open_issues_count%3A%202%0A%20%20%20%20license%3A%0A%20%20%20%20forks%3A%201%0A%20%20%20%20open_issues%3A%202%0A%20%20%20%20watchers%3A%200%0A%20%20%20%20default_branch%3A%20master%0A%20%20%20%20is_template%3A%20false%0A%20%20sender%3A%0A%20%20%20%20login%3A%20octocat%0A%20%20%20%20id%3A%2021031067%0A%20%20%20%20node_id%3A%20MDQ6VXNlcjIxMDMxMDY3%0A%20%20%20%20avatar_url%3A%20https%3A%2F%2Favatars1.githubusercontent.com%2Fu%2F21031067%3Fv%3D4%0A%20%20%20%20gravatar_id%3A%20%27%27%0A%20%20%20%20url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%0A%20%20%20%20html_url%3A%20https%3A%2F%2Fgithub.com%2Foctocat%0A%20%20%20%20followers_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowers%0A%20%20%20%20following_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Ffollowing%7B%2Fother_user%7D%0A%20%20%20%20gists_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fgists%7B%2Fgist_id%7D%0A%20%20%20%20starred_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fstarred%7B%2Fowner%7D%7B%2Frepo%7D%0A%20%20%20%20subscriptions_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fsubscriptions%0A%20%20%20%20organizations_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Forgs%0A%20%20%20%20repos_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Frepos%0A%20%20%20%20events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Fevents%7B%2Fprivacy%7D%0A%20%20%20%20received_events_url%3A%20https%3A%2F%2Fapi.github.com%2Fusers%2Foctocat%2Freceived_events%0A%20%20%20%20type%3A%20User%0A%20%20%20%20site_admin%3A%20false%0A parameters: {} headers: {} responses: not_modified: description: Not modified not_found: description: Resource not found content: application/json: schema: $ref: '#/components/schemas/basic-error'