{ "openapi": "3.1.0", "info": { "version": "12.2.0", "title": "GitHub's official Webhooks OpenAPI spec + Octokit extension", "description": "Webhooks OpenAPI specs from https://github.com/github/rest-api-description with the 'x-octokit' extension required by the Octokit SDKs", "license": { "name": "MIT", "url": "https://spdx.org/licenses/MIT" }, "termsOfService": "https://docs.github.com/articles/github-terms-of-service", "contact": { "name": "Support", "url": "https://github.com/octokit/openapi" }, "x-github-plan": "ghec" }, "tags": [ { "name": "actions", "description": "Endpoints to manage GitHub Actions using the REST API." }, { "name": "activity", "description": "Activity APIs provide access to notifications, subscriptions, and timelines." }, { "name": "apps", "description": "Information for integrations and installations." }, { "name": "billing", "description": "Monitor charges and usage from Actions and Packages." }, { "name": "checks", "description": "Rich interactions with checks run by your integrations." }, { "name": "code-scanning", "description": "Retrieve code scanning alerts from a repository." }, { "name": "codes-of-conduct", "description": "Insight into codes of conduct for your communities." }, { "name": "emojis", "description": "List emojis available to use on GitHub." }, { "name": "dependabot", "description": "Endpoints to manage Dependabot." }, { "name": "dependency-graph", "description": "Endpoints to access Dependency Graph features." }, { "name": "gists", "description": "View, modify your gists." }, { "name": "git", "description": "Raw Git functionality." }, { "name": "gitignore", "description": "View gitignore templates" }, { "name": "issues", "description": "Interact with GitHub Issues." }, { "name": "licenses", "description": "View various OSS licenses." }, { "name": "markdown", "description": "Render GitHub flavored Markdown" }, { "name": "merge-queue", "description": "Interact with GitHub Merge Queues." }, { "name": "meta", "description": "Endpoints that give information about the API." }, { "name": "migrations", "description": "Move projects to or from GitHub." }, { "name": "oidc", "description": "Endpoints to manage GitHub OIDC configuration using the REST API." }, { "name": "orgs", "description": "Interact with organizations." }, { "name": "packages", "description": "Manage packages for authenticated users and organizations." }, { "name": "pulls", "description": "Interact with GitHub Pull Requests." }, { "name": "rate-limit", "description": "Check your current rate limit status." }, { "name": "reactions", "description": "Interact with reactions to various GitHub entities." }, { "name": "repos", "description": "Interact with GitHub Repos." }, { "name": "search", "description": "Search for specific items on GitHub." }, { "name": "secret-scanning", "description": "Retrieve secret scanning alerts from a repository." }, { "name": "teams", "description": "Interact with GitHub Teams." }, { "name": "users", "description": "Interact with and view information about users and also current user." }, { "name": "code-quality", "description": "Insights into reliability, maintainability, and efficiency of your codebase." }, { "name": "codespaces", "description": "Endpoints to manage Codespaces using the REST API." }, { "name": "copilot", "description": "Endpoints to manage Copilot using the REST API." }, { "name": "copilot-spaces", "description": "Endpoints to manage Copilot Spaces using the REST API." }, { "name": "enterprise-admin", "description": "Enterprise Administration" }, { "name": "scim", "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "server-statistics", "description": "Server statistics" }, { "name": "security-advisories", "description": "Manage security advisories." }, { "name": "interactions", "description": "Owner or admin management of users interactions." }, { "name": "classroom", "description": "Interact with GitHub Classroom." }, { "name": "desktop", "description": "Desktop specific endpoints." }, { "name": "dsr", "description": "Endpoints to manage DSR operations." }, { "name": "enterprise-teams", "description": "Endpoints to manage GitHub Enterprise Teams." }, { "name": "enterprise-team-memberships", "description": "Endpoints to manage GitHub Enterprise Team memberships." }, { "name": "enterprise-team-organizations", "description": "Endpoints to manage GitHub Enterprise Team organization assignments." }, { "name": "code-security", "description": "Endpoints to manage Code security using the REST API." }, { "name": "private-registries", "description": "Manage private registry configurations." }, { "name": "hosted-compute", "description": "Manage hosted compute networking resources." }, { "name": "campaigns", "description": "Endpoints to manage campaigns via the REST API." }, { "name": "credentials", "description": "Revoke compromised or leaked GitHub credentials." }, { "name": "projects", "description": "Endpoints to manage Projects using the REST API." }, { "name": "agent-tasks", "description": "Endpoints to manage and interact with agent tasks." }, { "name": "agents", "description": "Endpoints for Agents secrets and variables." } ], "servers": [{ "url": "https://api.github.com" }], "externalDocs": { "description": "GitHub Enterprise Cloud REST API", "url": "https://docs.github.com/enterprise-cloud@latest/rest/" }, "webhooks": { "branch-protection-configuration-disabled": { "post": { "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "All branch protections were disabled for a repository.", "operationId": "branch-protection-configuration/disabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "branch_protection_configuration", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-branch-protection-configuration-disabled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "branch_protection_configuration", "supported-webhook-types": ["repository", "organization", "app"] } } }, "branch-protection-configuration-enabled": { "post": { "summary": "This event occurs when there is a change to branch protection configurations for a repository.\nFor more information, see \"[About protected branches](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\"\nFor information about using the APIs to manage branch protection rules, see \"[Branch protection rule](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "All branch protections were enabled for a repository.", "operationId": "branch-protection-configuration/enabled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_configuration" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "branch_protection_configuration", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-branch-protection-configuration-enabled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "branch_protection_configuration", "supported-webhook-types": ["repository", "organization", "app"] } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "branch_protection_rule", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "branch_protection_rule", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-cloud@latest/rest/branches/branch-protection)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#branch_protection_rule" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "branch_protection_rule", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "bypass-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass request was cancelled.", "operationId": "exemption-request-secret-scanning/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "bypass_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "bypass-request-secret-scanning-completed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning bypass request was completed.", "operationId": "exemption-request-secret-scanning/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "bypass_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "bypass-request-secret-scanning-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass request was created.", "operationId": "exemption-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "bypass_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "bypass-request-secret-scanning-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A secret scanning push protection bypass response was dismissed.", "operationId": "exemption-request-secret-scanning/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "bypass_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "bypass_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "bypass-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass secret scanning push protection.\n\nFor more information, see \"[Enabling delegated bypass for push protection](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/delegated-bypass-for-push-protection/about-delegated-bypass-for-push-protection#enabling-delegated-bypass-for-push-protection).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\nNote: Delegated bypass for push protection is currently in public preview and subject to change.", "description": "A response either approving or rejecting the secret scanning push protection bypass request was submitted.", "operationId": "exemption-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#bypass_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "bypass_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "bypass_request_secret_scanning", "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-check-run-completed" }, "examples": { "default": { "$ref": "#/components/examples/check-run-completed" } } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-check-run-created" }, "examples": { "default": { "$ref": "#/components/examples/check-run-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": "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/developers/apps/guides/creating-ci-tests-with-the-checks-api).\"", "operationId": "check-run/requested-action", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-check-run-requested-action" }, "examples": { "default": { "$ref": "#/components/examples/check-run-requested-action" } } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs)\" in the REST API documentation.\n\nFor activity relating to check suites, use the `check-suite` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `created` and `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/webhooks/webhook-events-and-payloads#check_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-check-run-rerequested" }, "examples": { "default": { "$ref": "#/components/examples/check-run-rerequested" } } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_suite", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/graphql/reference/mutations#createcheckrun) or \"[Create a check run](https://docs.github.com/enterprise-cloud@latest/rest/checks/runs#create-a-check-run)\" in the REST API documentation.", "operationId": "check-suite/requested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_suite", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#checksuite) or \"[Check Suites](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites)\" in the REST API documentation.\n\nFor activity relating to check runs, use the `check_run` event.\n\nTo 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.\n\nRepository and organization webhooks only receive payloads for the `completed` event types in repositories.\n\n> [!NOTE]\n> 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-cloud@latest/graphql/reference/mutations#createchecksuite) or \"[Create a check suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#create-a-check-suite)\" in the REST API documentation.", "operationId": "check-suite/rerequested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#check_suite" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "check_suite", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "code-scanning-alert-updated-assignment": { "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-cloud@latest/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-cloud@latest/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-cloud@latest/rest/code-scanning)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Code scanning alerts\" repository permission.", "description": "The assignees list of a code scanning alert has been updated.", "operationId": "code-scanning-alert/updated-assignment", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#code_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "code_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-code-scanning-alert-updated-assignment" } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#commitcomment) or \"[Commit comments](https://docs.github.com/enterprise-cloud@latest/rest/commits/comments)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#commit_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "commit_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n**Notes**:\n- This event will not occur when more than three tags are created at once.\n- 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-cloud@latest/webhooks/webhook-events-and-payloads#create" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "create", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "custom-property-created": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A new custom property was created.", "operationId": "custom-property/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-custom-property-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": ["business", "organization", "app"] } } }, "custom-property-deleted": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was deleted.", "operationId": "custom-property/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-custom-property-deleted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": ["business", "organization", "app"] } } }, "custom-property-promoted-to-enterprise": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was promoted to an enterprise.", "operationId": "custom-property/promote-to-enterprise", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-custom-property-promoted-to-enterprise" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": ["business", "organization", "app"] } } }, "custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to a custom property.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/orgs/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "A custom property was updated.", "operationId": "custom-property/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-custom-property-updated" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "custom_property", "supported-webhook-types": ["business", "organization", "app"] } } }, "custom-property-values-updated": { "post": { "summary": "This event occurs when there is activity relating to custom property values for a repository.\n\nFor more information, see \"[Managing custom properties for repositories in your organization](https://docs.github.com/enterprise-cloud@latest/organizations/managing-organization-settings/managing-custom-properties-for-repositories-in-your-organization)\". For information about the APIs to manage custom properties for a repository, see \"[Custom properties](https://docs.github.com/enterprise-cloud@latest/rest/repos/custom-properties)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Custom properties\" organization permission.", "description": "The custom property values of a repository were updated.", "operationId": "custom-property-values/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#custom-property-values" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "custom_property_values", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-custom-property-values-updated" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "custom-property-values", "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\nbranch and tag deletions, use the [`push`](#push) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> This event will not occur when more than three tags are deleted at once.", "operationId": "delete", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#delete" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "delete", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-assignees-changed": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "The assignees for a Dependabot alert were updated.", "operationId": "dependabot-alert/assignees-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-dependabot-alert-assignees-changed" } } } }, "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-auto-dismissed": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was automatically closed by a Dependabot auto-triage rule.", "operationId": "dependabot-alert/auto-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-dependabot-alert-auto-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-auto-reopened": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert, that had been automatically closed by a Dependabot auto-triage rule, was automatically reopened because the alert metadata or rule changed.", "operationId": "dependabot-alert/auto-reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-dependabot-alert-auto-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"] } } }, "dependabot-alert-created": { "post": { "summary": "This event occurs when there is activity relating to Dependabot alerts.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "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-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was manually closed.", "operationId": "dependabot-alert/dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A manifest file change removed a vulnerability.", "operationId": "dependabot-alert/fixed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "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-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about Dependabot alerts, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/dependabot/alerts)\" in the REST API documentation.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert was manually reopened.", "operationId": "dependabot-alert/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dependabot_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dependabot_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deploy_key", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/developers/overview/managing-deploy-keys).\" For information about the APIs to manage deploy keys, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deploykey) or \"[Deploy keys](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#deploy_key" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deploy_key", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment status, use the `deployment_status` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#deployment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deployment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-protection-rule-requested": { "post": { "summary": "This event occurs when there is activity relating to deployment protection rules. For more information, see \"[Using environments for deployment](https://docs.github.com/enterprise-cloud@latest/actions/deployment/targeting-different-environments/using-environments-for-deployment#environment-protection-rules).\" For information about the API to manage deployment protection rules, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/deployments/environments).\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.", "description": "A deployment protection rule was requested for an environment.", "operationId": "deployment-protection-rule/requested", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_protection_rule" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deployment_protection_rule", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-deployment-protection-rule-requested" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "deployment_protection_rule", "supported-webhook-types": ["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-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deployment_review", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deployment_review", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation or deployment status, use the `deployment` or `deployment_status` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#deployment_review" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deployment_review", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/deployment/about-deployments).\" For information about the APIs to manage deployments, see [the GraphQL API documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#deployment) or \"[Deployments](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments)\" in the REST API documentation.\n\nFor activity relating to deployment creation, use the `deployment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Deployments\" repository permission.\n\n> [!NOTE]\n> A webhook event is not fired for deployment statuses with an `inactive` state.", "description": "A new deployment status was created.", "operationId": "deployment-status/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#deployment_status" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "deployment_status", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "The category of a discussion was changed.", "operationId": "discussion/category-changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was closed.", "operationId": "discussion/closed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussions", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was created.", "operationId": "discussion-comment/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was deleted.", "operationId": "discussion-comment/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a discussion as opposed to comments on a discussion, use the `discussion` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A comment on a discussion was edited.", "operationId": "discussion-comment/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was created.", "operationId": "discussion/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was deleted.", "operationId": "discussion/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was added to a discussion.", "operationId": "discussion/labeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was locked.", "operationId": "discussion/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was pinned.", "operationId": "discussion/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was reopened.", "operationId": "discussion/reopened", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussions", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was transferred to another repository.", "operationId": "discussion/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A label was removed from a discussion.", "operationId": "discussion/unlabeled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unlocked.", "operationId": "discussion/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/discussions).\" For information about the API to manage discussions, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#discussion).\n\nFor activity relating to a comment on a discussion, use the `discussion_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Discussions\" repository permission.\n\n> [!NOTE]\n> Webhook events for GitHub Discussions are currently in public preview and subject to change.", "description": "A discussion was unpinned.", "operationId": "discussion/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#discussion" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "discussion", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "dismissal-request-code-scanning-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo 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 dismissal request was created.", "operationId": "dismissal-request-code-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_code_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-code-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a code scanning alert.\n\nTo 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 dismissal response was submitted.", "operationId": "dismissal-request-code-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_code_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_code_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_code_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-dependabot-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a Dependabot alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert dismissal request was canceled.", "operationId": "dismissal-request-dependabot/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_dependabot", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_dependabot", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-dependabot-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a Dependabot alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert dismissal request was created.", "operationId": "dismissal-request-dependabot/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_dependabot", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_dependabot", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-dependabot-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a Dependabot alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Dependabot alerts\" repository permission.", "description": "A Dependabot alert dismissal request received a response.", "operationId": "dismissal-request-dependabot/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_dependabot" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_dependabot", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_dependabot", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-secret-scanning-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", "description": "A secret scanning alert dismissal request was canceled.", "operationId": "dismissal-request-secret-scanning/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-secret-scanning-completed": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", "description": "A secret scanning alert dismissal request was completed.", "operationId": "dismissal-request-secret-scanning/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-secret-scanning-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", "description": "A secret scanning alert dismissal request was created.", "operationId": "dismissal-request-secret-scanning/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-secret-scanning-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", "description": "A secret scanning alert dismissal response was dismissed.", "operationId": "dismissal-request-secret-scanning/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "dismissal-request-secret-scanning-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to dismiss a secret scanning alert.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.\n\n[!NOTE]\nDelegated alert dismissal for secret scanning is currently in public preview and subject to change.", "description": "A secret scanning alert dismissal response was submitted.", "operationId": "dismissal-request-secret-scanning/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#dismissal_request_secret_scanning" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "dismissal_request_secret_scanning", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "dismissal_request_secret_scanning", "supported-webhook-types": ["repository", "organization", "app"] } } }, "exemption-request-push-ruleset-cancelled": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was cancelled.", "operationId": "exemption-request-push-ruleset/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "exemption_request_push_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "exemption-request-push-ruleset-completed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was completed.", "operationId": "exemption-request-push-ruleset/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "exemption_request_push_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-completed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "exemption-request-push-ruleset-created": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass request was created.", "operationId": "exemption-request-push-ruleset/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "exemption_request_push_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "exemption-request-push-ruleset-response-dismissed": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A push ruleset bypass response was dismissed.", "operationId": "exemption-request-push-ruleset/response-dismissed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "exemption_request_push_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-dismissed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "exemption-request-push-ruleset-response-submitted": { "post": { "summary": "This event occurs when there is activity related to a user's request to bypass a set of push rules.\n\nFor more information, see \"[Managing requests to bypass push rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/managing-rulesets-for-a-repository#managing-requests-to-bypass-push-rules).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository permission.", "description": "A response either approving or rejecting the push ruleset bypass request was submitted.", "operationId": "exemption-request-push-ruleset/response-submitted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#exemption_request_push_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "exemption_request_push_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-exemption-request-response-submitted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "exemption_request_push_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "fork": { "post": { "summary": "This event occurs when someone forks a repository. For more information, see \"[Fork a repo](https://docs.github.com/enterprise-cloud@latest/get-started/quickstart/fork-a-repo).\" For information about the API to manage forks, see \"[Forks](https://docs.github.com/enterprise-cloud@latest/rest/repos/forks)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#fork" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "fork", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/rest/apps)\" in the REST API documentation.\n\nA GitHub App receives this webhook by default and cannot unsubscribe from this event.\n\nAnyone 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#github_app_authorization" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "github_app_authorization", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/communities/documenting-your-project-with-wikis/about-wikis).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#gollum" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "gollum", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation_repositories", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation_repositories" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation_repositories", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation_target" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation_target", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about GitHub Apps, see \"[About apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#app) or \"[Apps](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#installation" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "installation", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor 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-cloud@latest/rest/guides/working-with-comments).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor 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-cloud@latest/rest/guides/working-with-comments).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor 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-cloud@latest/rest/guides/working-with-comments).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "issue-comment-pinned": { "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-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor 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-cloud@latest/rest/guides/working-with-comments).\"\n\nTo 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 was pinned.", "operationId": "issue-comment/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-comment-pinned" } } } }, "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-unpinned": { "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-cloud@latest/issues/tracking-your-work-with-issues/about-issues)\" and \"[About pull requests](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#issuecomment) or \"[Issue comments](https://docs.github.com/enterprise-cloud@latest/rest/issues/comments)\" in the REST API documentation.\n\nFor 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-cloud@latest/rest/guides/working-with-comments).\"\n\nTo 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 was unpinned.", "operationId": "issue-comment/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-comment-unpinned" } } } }, "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-dependencies-blocked-by-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "An issue was marked as blocked by another issue.", "operationId": "issue-dependencies/blocked-by-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_dependencies", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-added" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "issue-dependencies", "supported-webhook-types": ["repository", "organization", "app"] } } }, "issue-dependencies-blocked-by-removed": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "The blocked by relationship between an issue and another issue was removed.", "operationId": "issue-dependencies/blocked-by-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_dependencies", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-dependencies-blocked-by-removed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "issue-dependencies", "supported-webhook-types": ["repository", "organization", "app"] } } }, "issue-dependencies-blocking-added": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "An issue was marked as blocking another issue.", "operationId": "issue-dependencies/blocking-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_dependencies", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-added" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "issue-dependencies", "supported-webhook-types": ["repository", "organization", "app"] } } }, "issue-dependencies-blocking-removed": { "post": { "summary": "This event occurs when there is activity relating to issue dependencies, such as blocking or blocked-by relationships.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "The blocking relationship between an issue and another issue was removed.", "operationId": "issue-dependencies/blocking-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-dependencies" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_dependencies", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-dependencies-blocking-removed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "issue-dependencies", "supported-webhook-types": ["repository", "organization", "app"] } } }, "issue-relates-to-added": { "post": { "summary": "This event occurs when there is activity relating to a \"relates to\" relationship between two issues.\n\nFor relationships between issues in the same repository, GitHub sends one delivery containing both issues. For relationships between issues in different repositories, GitHub sends one delivery for each repository. Each cross-repository delivery contains only the issue in the repository receiving the delivery and omits the related issue, its ID, and its repository details.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "An issue was marked as related to another issue.", "operationId": "issue-relates-to/relates-to-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-relates-to" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_relates_to", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-relates-to-added" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "issue-relates-to", "supported-webhook-types": ["repository", "organization", "app"] } } }, "issue-relates-to-removed": { "post": { "summary": "This event occurs when there is activity relating to a \"relates to\" relationship between two issues.\n\nFor relationships between issues in the same repository, GitHub sends one delivery containing both issues. For relationships between issues in different repositories, GitHub sends one delivery for each repository. Each cross-repository delivery contains only the issue in the repository receiving the delivery and omits the related issue, its ID, and its repository details.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "An issue's relationship to another issue was removed.", "operationId": "issue-relates-to/relates-to-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issue-relates-to" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issue_relates_to", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issue-relates-to-removed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "issue-relates-to", "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-field-added": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue field value was set or updated on an issue.", "operationId": "issues/field-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issues-field-added" } } } }, "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-field-removed": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue field value was cleared from an issue.", "operationId": "issues/field-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issues-field-removed" } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/pinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/issues/tracking-your-work-with-issues/transferring-an-issue-to-another-repository).\"", "operationId": "issues/transferred", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-typed": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue type was added to an issue.", "operationId": "issues/typed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issues-typed" } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "issues/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo 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-cloud@latest/issues/tracking-your-work-with-issues/pinning-an-issue-to-your-repository).\"", "operationId": "issues/unpinned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "issues-untyped": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#issue) or \"[Issues](https://docs.github.com/enterprise-cloud@latest/rest/issues)\" in the REST API documentation.\n\nFor activity relating to a comment on an issue, use the `issue_comment` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permission.", "description": "An issue type was removed from an issue.", "operationId": "issues/untyped", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-issues-untyped" } } } }, "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-archived": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was archived.", "operationId": "label/archived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "label", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-label-archived" } } } }, "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-created": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "label", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "label", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "label", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "label-unarchived": { "post": { "summary": "This event occurs when there is activity relating to labels. For more information, see \"[Managing labels](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/graphql/reference/objects#label) or \"[Labels](https://docs.github.com/enterprise-cloud@latest/rest/issues/labels)\" in the REST API documentation.\n\nIf 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Metadata\" repository permission.", "description": "A label was unarchived.", "operationId": "label/unarchived", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#label" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "label", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-label-unarchived" } } } }, "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"] } } }, "marketplace-purchase-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone cancelled a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "marketplace_purchase", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-marketplace-purchase-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "marketplace_purchase", "supported-webhook-types": ["marketplace"] } } }, "marketplace-purchase-changed": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone upgraded or downgraded a GitHub Marketplace plan, and the last billing cycle has ended. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/changed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "marketplace_purchase", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-marketplace-purchase-changed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "marketplace_purchase", "supported-webhook-types": ["marketplace"] } } }, "marketplace-purchase-pending-change": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone downgraded or cancelled a GitHub Marketplace plan. The new plan or cancellation will take effect at the end of the current billing cycle. When the change takes effect, the `changed` or `cancelled` event will be sent.", "operationId": "marketplace-purchase/pending-change", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "marketplace_purchase", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "marketplace_purchase", "supported-webhook-types": ["marketplace"] } } }, "marketplace-purchase-pending-change-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone cancelled a pending change to a GitHub Marketplace plan. Pending changes include plan cancellations and downgrades that will take effect at the end of a billing cycle.", "operationId": "marketplace-purchase/pending-change-cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "marketplace_purchase", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-marketplace-purchase-pending-change-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "marketplace_purchase", "supported-webhook-types": ["marketplace"] } } }, "marketplace-purchase-purchased": { "post": { "summary": "This event occurs when there is activity relating to a GitHub Marketplace purchase. For more information, see \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/marketplace).\" For information about the APIs to manage GitHub Marketplace listings, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#marketplacelisting) or \"[GitHub Marketplace](https://docs.github.com/enterprise-cloud@latest/rest/apps/marketplace)\" in the REST API documentation.", "description": "Someone purchased a GitHub Marketplace plan. The change will take effect on the account immediately.", "operationId": "marketplace-purchase/purchased", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#marketplace_purchase" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "marketplace_purchase", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-marketplace-purchase-purchased" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "marketplace_purchase", "supported-webhook-types": ["marketplace"] } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "member", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "member", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#repositorycollaboratorconnection) or \"[Collaborators](https://docs.github.com/enterprise-cloud@latest/rest/collaborators/collaborators)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#member" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "member", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "membership", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#team) or \"[Team members](https://docs.github.com/enterprise-cloud@latest/rest/teams/members)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#membership" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "membership", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "merge-group-checks-requested": { "post": { "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", "description": "Status checks were requested for a merge group. This happens when a merge group is created or added to by the merge queue because a pull request was queued.\n\nWhen you receive this event, you should perform checks on the head SHA and report status back using check runs or commit statuses.", "operationId": "merge-group/checks-requested", "tags": ["merge-queue"], "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "merge_group", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-merge-group-checks-requested" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "merge_group", "supported-webhook-types": ["app"] } } }, "merge-group-destroyed": { "post": { "summary": "This event occurs when there is activity relating to a merge group in a merge queue. For more information, see \"[Managing a merge queue](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/configuring-pull-request-merges/managing-a-merge-queue).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Merge queues\" repository permission.", "description": "The merge queue groups pull requests together to be merged. This event indicates that one of those merge groups was destroyed. This happens when a pull request is removed from the queue: any group containing that pull request is also destroyed.\n\nWhen you receive this event, you may want to cancel any checks that are running on the head SHA to avoid wasting computing resources on a merge group that will not be used.", "operationId": "merge-group/destroyed", "tags": ["merge-queue"], "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#merge_group" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "merge_group", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-merge-group-destroyed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "merge_group", "supported-webhook-types": ["app"] } } }, "meta-deleted": { "post": { "summary": "This event occurs when there is activity relating to a webhook itself.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#meta" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "meta", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "milestone", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "milestone", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "milestone", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "milestone", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#milestone) or \"[Milestones](https://docs.github.com/enterprise-cloud@latest/rest/issues/milestones)\" in the REST API documentation.\n\nIf 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#milestone" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "milestone", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "org-block-blocked": { "post": { "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", "description": "A user was blocked from the organization.", "operationId": "org-block/blocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "org_block", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-org-block-blocked" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "org_block", "supported-webhook-types": ["organization", "business", "app"] } } }, "org-block-unblocked": { "post": { "summary": "This event occurs when organization owners or moderators block or unblock a non-member from collaborating on the organization's repositories. For more information, see \"[Blocking a user from your organization](https://docs.github.com/enterprise-cloud@latest/communities/maintaining-your-safety-on-github/blocking-a-user-from-your-organization).\" For information about the APIs to manage blocked users, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#userblockedevent) or \"[Blocking users](https://docs.github.com/enterprise-cloud@latest/rest/orgs/blocking)\" in the REST API documentation.\n\nIf you want to receive an event when members are added or removed from an organization, use the `organization` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" organization permission.", "description": "A previously blocked user was unblocked from the organization.", "operationId": "org-block/unblocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#org_block" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "org_block", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-org-block-unblocked" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "org_block", "supported-webhook-types": ["organization", "business", "app"] } } }, "organization-custom-property-created": { "post": { "summary": "This event occurs when there is activity relating to an organization custom property.", "description": "A new organization custom property was created.", "operationId": "organization-custom-property/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization_custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-organization-custom-property-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "organization_custom_property", "supported-webhook-types": ["business"] } } }, "organization-custom-property-deleted": { "post": { "summary": "This event occurs when there is activity relating to an organization custom property.", "description": "An organization custom property was deleted.", "operationId": "organization-custom-property/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization_custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-organization-custom-property-deleted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "organization_custom_property", "supported-webhook-types": ["business"] } } }, "organization-custom-property-updated": { "post": { "summary": "This event occurs when there is activity relating to an organization custom property.", "description": "An organization custom property was updated.", "operationId": "organization-custom-property/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization_custom_property" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization_custom_property", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-organization-custom-property-updated" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "organization_custom_property", "supported-webhook-types": ["business"] } } }, "organization-custom-property-values-updated": { "post": { "summary": "This event occurs when there is activity relating to custom property values for an organization.", "description": "The custom property values of an organization were updated.", "operationId": "organization-custom-property-values/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#organization-custom-property-values" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization_custom_property_values", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-organization-custom-property-values-updated" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": true, "category": "webhooks", "subcategory": "organization-custom-property-values", "supported-webhook-types": ["business", "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-cloud@latest/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-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#organization) or \"[Organizations](https://docs.github.com/enterprise-cloud@latest/rest/orgs)\" in the REST API documentation.\n\nIf you want to receive an event when a non-member is blocked or unblocked from an organization, use the `org_block` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#organization" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "organization", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.", "description": "A package was published to a registry.", "operationId": "package/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "package", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.", "description": "A previously published package was updated.", "operationId": "package/updated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#package" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "package", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "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-cloud@latest/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-cloud@latest/rest/pages)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#page_build" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "page_build", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "personal-access-token-request-approved": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was approved.", "operationId": "personal-access-token-request/approved", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "personal_access_token_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "integration", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-personal-access-token-request-approved" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "personal_access_token_request", "supported-webhook-types": ["app", "organization"] } } }, "personal-access-token-request-cancelled": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was cancelled by the requester.", "operationId": "personal-access-token-request/cancelled", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "personal_access_token_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "integration", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-personal-access-token-request-cancelled" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "personal_access_token_request", "supported-webhook-types": ["app", "organization"] } } }, "personal-access-token-request-created": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was created.", "operationId": "personal-access-token-request/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "personal_access_token_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "integration", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-personal-access-token-request-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "personal_access_token_request", "supported-webhook-types": ["app", "organization"] } } }, "personal-access-token-request-denied": { "post": { "summary": "This event occurs when there is activity relating to a request for a fine-grained personal access token to access resources that belong to a resource owner that requires approval for token access. For more information, see \"[Creating a personal access token](https://docs.github.com/enterprise-cloud@latest/authentication/keeping-your-account-and-data-secure/creating-a-personal-access-token).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Personal access token requests\" organization permission.", "description": "A fine-grained personal access token request was denied.", "operationId": "personal-access-token-request/denied", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#personal_access_token_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "personal_access_token_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "integration", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-personal-access-token-request-denied" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "personal_access_token_request", "supported-webhook-types": ["app", "organization"] } } }, "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-cloud@latest/webhooks/webhook-events-and-payloads#ping" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "ping", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-ping" }, "examples": { "default": { "$ref": "#/components/examples/ping" } } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_card", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_card", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_card", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_card", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a column on a project (classic), use the `project` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_card" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_card", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_column", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_column", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_column", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a project (classic) or a card on a project (classic), use the `project` and `project_card` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project_column" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project_column", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#project) or \"[Projects (classic)](https://docs.github.com/enterprise-cloud@latest/rest/projects)\" in the REST API documentation.\n\nFor activity relating to a card or column on a project (classic), use the `project_card` and `project_column` event.\n\nThis event relates to projects (classic) only. For activity relating to the new Projects experience, use the `projects_v2` event instead.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#project" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2item).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_item" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-item", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#projectv2).\n\nFor 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.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> Webhook events for projects are currently in public preview 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-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "projects-v2-status-update-created": { "post": { "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was added to a project in the organization.", "operationId": "projects-v2-status-update/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-status-update", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-projects-v2-status-update-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_status_update", "supported-webhook-types": ["organization"] } } }, "projects-v2-status-update-deleted": { "post": { "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was removed from a project in the organization.", "operationId": "projects-v2-status-update/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-status-update", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-projects-v2-status-update-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_status_update", "supported-webhook-types": ["organization"] } } }, "projects-v2-status-update-edited": { "post": { "summary": "This event occurs when there is activity relating to a status update on an organization-level project. For more information, see \"[About Projects](https://docs.github.com/enterprise-cloud@latest/issues/planning-and-tracking-with-projects/learning-about-projects/about-projects).\"\n\nFor activity relating to a project, use the `projects_v2` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Projects\" organization permission.\n\n> [!NOTE]\n> To share feedback about projects webhooks with GitHub, see the [Projects webhook feedback discussion](https://github.com/orgs/community/discussions/17405).", "description": "A status update was edited on a project in the organization.", "operationId": "projects-v2-status-update/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#projects_v2_status_update" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "project-v2-status-update", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-projects-v2-status-update-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_status_update", "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-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/setting-repository-visibility).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#public" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "public", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-dequeued": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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 the merge queue.", "operationId": "pull-request/dequeued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-pull-request-dequeued" } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-enqueued": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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 the merge queue.", "operationId": "pull-request/enqueued", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-pull-request-enqueued" } } } }, "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/locked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreviewcomment) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_comment" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review_comment", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreview) or \"[Pull request reviews](https://docs.github.com/enterprise-cloud@latest/rest/pulls/reviews)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review_thread", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequestreviewthread) or \"[Pull request review comments](https://docs.github.com/enterprise-cloud@latest/rest/pulls/comments)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request_review_thread" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request_review_thread", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-stacked": { "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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 stack.", "operationId": "pull-request/stacked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-pull-request-stacked" } } } }, "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-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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#pullrequest) or \"[Pulls](https://docs.github.com/enterprise-cloud@latest/rest/pulls/pulls)\" in the REST API documentation.\n\nFor 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.\n\nTo 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-cloud@latest/communities/moderating-comments-and-conversations/locking-conversations).\"", "operationId": "pull-request/unlocked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#pull_request" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "pull_request", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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,\nwhen a branch is deleted, when a tag is deleted, or when a repository is created from a template. To subscribe to only branch\nand tag deletions, use the [`delete`](#delete) webhook event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.\n\n> [!NOTE]\n> Events will not be created if more than 5000 branches are pushed at once. Events will not be created for tags when more than three tags are pushed at once.", "operationId": "push", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#push" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "push", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> 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-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "registry_package", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#package) or \"[Packages](https://docs.github.com/enterprise-cloud@latest/rest/packages)\" in the REST API documentation.\n\nTo install this event on a GitHub App, the app must have at least read-level access for the \"Packages\" repository permission.\n\n> [!NOTE]\n> 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-cloud@latest/webhooks/webhook-events-and-payloads#registry_package" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "registry_package", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/repositories/releasing-projects-on-github/managing-releases-in-a-repository#editing-a-release).\"", "operationId": "release/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#release) or \"[Releases](https://docs.github.com/enterprise-cloud@latest/rest/releases)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#release" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "release", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-advisory-published": { "post": { "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", "description": "A repository security advisory was published.", "operationId": "repository-advisory/published", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_advisory", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-repository-advisory-published" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "repository_advisory", "supported-webhook-types": ["repository", "organization", "app"] } } }, "repository-advisory-reported": { "post": { "summary": "This event occurs when there is activity relating to a repository security advisory. For more information about repository security advisories, see \"[About GitHub Security Advisories for repositories](https://docs.github.com/enterprise-cloud@latest/code-security/repository-security-advisories/about-github-security-advisories-for-repositories).\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Repository security advisories\" permission.", "description": "A private vulnerability report was submitted.", "operationId": "repository-advisory/reported", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_advisory" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_advisory", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-repository-advisory-reported" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "repository_advisory", "supported-webhook-types": ["repository", "organization", "app"] } } }, "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/rest/repos/repos#create-a-repository-dispatch-event). In the payload, the `action` will be the `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Contents\" repository permission.", "operationId": "repository-dispatch/sample.collected", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_dispatch" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_dispatch", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-import": { "post": { "summary": "This event occurs when a repository is imported to GitHub Enterprise Cloud. For more information, see \"[Importing a repository with GitHub Importer](https://docs.github.com/enterprise-cloud@latest/get-started/importing-your-projects-to-github/importing-source-code-to-github/importing-a-repository-with-github-importer).\" For more information about the API to manage imports, see [the REST API documentation](https://docs.github.com/enterprise-cloud@latest/rest/migrations/source-imports).", "operationId": "repository-import", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_import" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_import", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-repository-import" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "repository_import", "supported-webhook-types": ["repository", "organization"] } } }, "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-ruleset-created": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was created.", "operationId": "repository-ruleset/created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-repository-ruleset-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "repository_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "repository-ruleset-deleted": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was deleted.", "operationId": "repository-ruleset/deleted", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-repository-ruleset-deleted" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "repository_ruleset", "supported-webhook-types": ["repository", "organization", "app"] } } }, "repository-ruleset-edited": { "post": { "summary": "This event occurs when there is activity relating to repository rulesets.\nFor more information about repository rulesets, see \"[Managing rulesets](https://docs.github.com/enterprise-cloud@latest/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets).\"\nFor more information on managing rulesets via the APIs, see [Repository ruleset](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repositoryruleset) in the GraphQL documentation or \"[Repository rules](https://docs.github.com/enterprise-cloud@latest/rest/repos/rules)\" and \"[Organization rules](https://docs.github.com/enterprise-cloud@latest/rest/orgs/rules) in the REST API documentation.\"\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Administration\" repository or organization permission.", "description": "A repository ruleset was edited.", "operationId": "repository-ruleset/edited", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#repository_ruleset" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_ruleset", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-repository-ruleset-edited" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "repository_ruleset", "supported-webhook-types": ["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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/repositories/creating-and-managing-repositories/about-repositories).\" For information about the APIs to manage repositories, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#repository) or \"[Repositories](https://docs.github.com/enterprise-cloud@latest/rest/repos)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#repository" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_vulnerability_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_vulnerability_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_vulnerability_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\n> [!WARNING]\n> **Closing down notice:** This event is closing down. 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-cloud@latest/webhooks/webhook-events-and-payloads#repository_vulnerability_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "repository_vulnerability_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-assigned": { "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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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 assigned.", "operationId": "secret-scanning-alert/assigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-alert-assigned" } } } }, "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-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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\n\nFor more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alerts, use the `secret_scanning_alert` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert_location" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert_location", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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" } } } } }, "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-metadata-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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "Metadata was created for a secret scanning alert.", "operationId": "secret-scanning-alert/metadata-created", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-created" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": ["repository", "organization", "app"] } } }, "secret-scanning-alert-metadata-removed": { "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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Secret scanning alerts\" repository permission.", "description": "Metadata was removed from a secret scanning alert.", "operationId": "secret-scanning-alert/metadata-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-alert-metadata-removed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "category": "webhooks", "subcategory": "secret_scanning_alert", "supported-webhook-types": ["repository", "organization", "app"] } } }, "secret-scanning-alert-publicly-leaked": { "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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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 detected in a public repo.", "operationId": "secret-scanning-alert/publicly-leaked", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-alert-publicly-leaked" } } } }, "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-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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-unassigned": { "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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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 unassigned.", "operationId": "secret-scanning-alert/unassigned", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-alert-unassigned" } } } }, "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-validated": { "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-cloud@latest/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-cloud@latest/rest/secret-scanning)\" in the REST API documentation.\n\nFor activity relating to secret scanning alert locations, use the `secret_scanning_alert_location` event.\n\nTo 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 validated.", "operationId": "secret-scanning-alert/validated", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_alert" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_alert", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-alert-validated" } } } }, "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-scan-completed": { "post": { "summary": "This event occurs when secret scanning completes certain scans on a repository. For more information about secret scanning, see \"[About secret scanning](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/about-secret-scanning).\"\n\nScans can originate from multiple events such as updates to a custom pattern, a push to a repository, or updates\nto patterns from partners. For more information on custom patterns, see \"[About custom patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/using-advanced-secret-scanning-and-push-protection-features/custom-patterns).\"\n\nTo 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 scan was completed.", "operationId": "secret-scanning-scan/completed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#secret_scanning_scan" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "secret_scanning_scan", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-secret-scanning-scan-completed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "secret_scanning_scan", "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-cloud@latest/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-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "security_advisory", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "security_advisory", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/security-advisories/global-advisories) or [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#securityadvisory).\n\nGitHub Dependabot alerts are also powered by the security advisory dataset. For more information, see \"[About Dependabot alerts](https://docs.github.com/enterprise-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#security_advisory" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "security_advisory", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/code-security/getting-started/github-security-features).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#security_and_analysis" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "security_and_analysis", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou 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-cloud@latest/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.\n\nThis 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-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sponsorship", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sponsorship", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sponsorship", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou 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-cloud@latest/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.\n\nThis 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-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sponsorship", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sponsorship", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#sponsorship).\n\nYou 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-cloud@latest/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-cloud@latest/webhooks/webhook-events-and-payloads#sponsorship" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sponsorship", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "star", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#starredrepositoryconnection) or \"[Starring](https://docs.github.com/enterprise-cloud@latest/rest/activity/starring)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#star" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "star", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/graphql/reference/objects#status) or \"[Commit statuses](https://docs.github.com/enterprise-cloud@latest/rest/commits/statuses)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#status" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "status", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "sub-issues-parent-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "A parent issue was added to an issue.", "operationId": "sub-issues/parent-issue-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sub_issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-added" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "sub-issues", "supported-webhook-types": ["repository", "organization", "app"] } } }, "sub-issues-parent-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "A parent issue was removed from an issue.", "operationId": "sub-issues/parent-issue-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sub_issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-sub-issues-parent-issue-removed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "sub-issues", "supported-webhook-types": ["repository", "organization", "app"] } } }, "sub-issues-sub-issue-added": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "A sub-issue was added to an issue.", "operationId": "sub-issues/sub-issue-added", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sub_issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-added" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "sub-issues", "supported-webhook-types": ["repository", "organization", "app"] } } }, "sub-issues-sub-issue-removed": { "post": { "summary": "This event occurs when there is activity relating to sub-issues.\n\nFor activity relating to issues more generally, use the `issues` event instead.\n\nTo subscribe to this event, a GitHub App must have at least read-level access for the \"Issues\" repository permissions.", "description": "A sub-issue was removed from an issue.", "operationId": "sub-issues/sub-issue-removed", "externalDocs": { "url": "https://docs.github.com/enterprise-cloud@latest/webhooks/webhook-events-and-payloads#sub-issues" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "sub_issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-sub-issues-sub-issue-removed" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "sub-issues", "supported-webhook-types": ["repository", "organization", "app"] } } }, "team-add": { "post": { "summary": "This event occurs when a team is added to a repository.\nFor more information, see \"[Managing teams and people with access to your repository](https://docs.github.com/enterprise-cloud@latest/repositories/managing-your-repositorys-settings-and-features/managing-repository-settings/managing-teams-and-people-with-access-to-your-repository).\"\n\nFor activity relating to teams, see the `teams` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#team_add" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "team_add", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "team", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "team", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "team", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "team", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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.\nFor more information, see \"[About teams](https://docs.github.com/enterprise-cloud@latest/organizations/organizing-members-into-teams/about-teams).\"\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#team" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "team", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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"] } } }, "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-cloud@latest/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-cloud@latest/rest/activity/watching)\" in the REST API documentation.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#watch" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "watch", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/managing-workflow-runs/manually-running-a-workflow).\"\n\nFor activity relating to workflow runs, use the `workflow_run` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_dispatch" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_dispatch", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_job", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_job", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_job", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/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-cloud@latest/rest/actions/workflow-jobs)\" in the REST API documentation.\n\nFor activity relating to a workflow run instead of a job in a workflow run, use the `workflow_run` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_job" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_job", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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-cloud@latest/actions/using-workflows/about-workflows).\" For information about the APIs to manage workflow runs, see [the GraphQL documentation](https://docs.github.com/enterprise-cloud@latest/graphql/reference/objects#workflowrun) or \"[Workflow runs](https://docs.github.com/enterprise-cloud@latest/rest/actions/workflow-runs)\" in the REST API documentation.\n\nFor activity relating to a job in a workflow run, use the `workflow_job` event.\n\nTo 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-cloud@latest/webhooks/webhook-events-and-payloads#workflow_run" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Id", "in": "header", "example": 12312312, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Event", "in": "header", "example": "workflow_run", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Type", "in": "header", "example": "repository", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Delivery", "in": "header", "example": "0b989ba4-242f-11e5-81e1-c7b6966d2516", "schema": { "type": "string" }, "required": true }, { "name": "X-Hub-Signature-256", "in": "header", "example": "sha256=6dcb09b5b57875f334f61aebed695e2e4193db5e", "schema": { "type": "string" }, "required": true } ], "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": { "webhook-branch-protection-configuration-disabled": { "title": "branch protection configuration disabled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "enterprise-webhooks": { "title": "Enterprise", "description": "An enterprise on GitHub. Webhook payloads contain the `enterprise` property when the webhook is configured\non an enterprise account or an organization that's part of an enterprise account. For more information,\nsee \"[About enterprise accounts](https://docs.github.com/enterprise-cloud@latest/admin/overview/about-enterprise-accounts).\"", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": ["string", "null"] }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/enterprises/octo-business"] }, "website_url": { "description": "The enterprise's website URL.", "type": ["string", "null"], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [42] }, "node_id": { "type": "string", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": ["Octo Business"] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": ["octo-business"] }, "created_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2019-01-26T19:01:12Z"] }, "updated_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2019-01-26T19:14:43Z"] }, "avatar_url": { "type": "string", "format": "uri" } }, "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\nfor and sent to a GitHub App. For more information,\nsee \"[Using webhooks with GitHub Apps](https://docs.github.com/enterprise-cloud@latest/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", "examples": [1] }, "node_id": { "description": "The global node ID of the installation.", "type": "string", "examples": ["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\norganization, or when the event occurs from activity in a repository owned by an organization.", "type": "object", "properties": { "login": { "type": "string", "examples": ["github"] }, "id": { "type": "integer", "examples": [1] }, "node_id": { "type": "string", "examples": ["MDEyOk9yZ2FuaXphdGlvbjE="] }, "url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/orgs/github"] }, "repos_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/orgs/github/repos"] }, "events_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/orgs/github/events"] }, "hooks_url": { "type": "string", "examples": ["https://api.github.com/orgs/github/hooks"] }, "issues_url": { "type": "string", "examples": ["https://api.github.com/orgs/github/issues"] }, "members_url": { "type": "string", "examples": ["https://api.github.com/orgs/github/members{/member}"] }, "public_members_url": { "type": "string", "examples": [ "https://api.github.com/orgs/github/public_members{/member}" ] }, "avatar_url": { "type": "string", "examples": ["https://github.com/images/error/octocat_happy.gif"] }, "description": { "type": ["string", "null"], "examples": ["A great organization"] } }, "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\nwhen the event occurs from activity in a repository.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [42] }, "node_id": { "type": "string", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "description": "The name of the repository.", "type": "string", "examples": ["Team Environment"] }, "full_name": { "type": "string", "examples": ["octocat/Hello-World"] }, "license": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/license-simple" } ] }, "organization": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "forks": { "type": "integer" }, "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" }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/octocat/Hello-World"] }, "description": { "type": ["string", "null"], "examples": ["This your first repo!"] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/repos/octocat/Hello-World"] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": ["git:github.com/octocat/Hello-World.git"] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": ["git@github.com:octocat/Hello-World.git"] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": ["http://api.github.com/repos/octocat/Hello-World/tags"] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": ["https://github.com/octocat/Hello-World.git"] }, "mirror_url": { "type": ["string", "null"], "format": "uri", "examples": ["git:git.example.com/octocat/Hello-World"] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": ["https://svn.github.com/octocat/Hello-World"] }, "homepage": { "type": ["string", "null"], "format": "uri", "examples": ["https://github.com"] }, "language": { "type": ["string", "null"] }, "forks_count": { "type": "integer", "examples": [9] }, "stargazers_count": { "type": "integer", "examples": [80] }, "watchers_count": { "type": "integer", "examples": [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", "examples": [108] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": ["master"] }, "open_issues_count": { "type": "integer", "examples": [0] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [true] }, "topics": { "type": "array", "items": { "type": "string" } }, "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 }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "examples": [true] }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "default": true, "type": "boolean", "examples": [true] }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "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", "null"], "format": "date-time", "examples": ["2011-01-26T19:06:43Z"] }, "created_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "updated_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:14:43Z"] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [true] }, "template_repository": { "type": ["object", "null"], "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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": ["PR_BODY", "PR_TITLE", "BLANK"], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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", "examples": [true] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [false] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [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", "examples": [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 is closing down. 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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": ["PR_BODY", "PR_TITLE", "BLANK"], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [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", "examples": ["\"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" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": { "properties": { "use_squash_pr_title_as_default": null, "template_repository": { "properties": { "use_squash_pr_title_as_default": null } } } }, "version": "2026-03-10" }, { "changeset": "deprecate_beta_media_type", "patch": { "properties": { "master_branch": null } }, "version": "2026-03-10" } ] }, "license-simple": { "title": "License Simple", "description": "License Simple", "type": "object", "properties": { "key": { "type": "string", "examples": ["mit"] }, "name": { "type": "string", "examples": ["MIT License"] }, "url": { "type": ["string", "null"], "format": "uri", "examples": ["https://api.github.com/licenses/mit"] }, "spdx_id": { "type": ["string", "null"], "examples": ["MIT"] }, "node_id": { "type": "string", "examples": ["MDc6TGljZW5zZW1pdA=="] }, "html_url": { "type": "string", "format": "uri" } }, "required": ["key", "name", "url", "spdx_id", "node_id"] }, "simple-user": { "title": "Simple User", "description": "A GitHub user.", "type": "object", "properties": { "name": { "type": ["string", "null"] }, "email": { "type": ["string", "null"] }, "login": { "type": "string", "examples": ["octocat"] }, "id": { "type": "integer", "format": "int64", "examples": [1] }, "node_id": { "type": "string", "examples": ["MDQ6VXNlcjE="] }, "avatar_url": { "type": "string", "format": "uri", "examples": ["https://github.com/images/error/octocat_happy.gif"] }, "gravatar_id": { "type": ["string", "null"], "examples": ["41d064eb2195891e12d0413f63227ea7"] }, "url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/users/octocat"] }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/octocat"] }, "followers_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/users/octocat/followers"] }, "following_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/following{/other_user}" ] }, "gists_url": { "type": "string", "examples": ["https://api.github.com/users/octocat/gists{/gist_id}"] }, "starred_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/starred{/owner}{/repo}" ] }, "subscriptions_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/users/octocat/subscriptions"] }, "organizations_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/users/octocat/orgs"] }, "repos_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/users/octocat/repos"] }, "events_url": { "type": "string", "examples": [ "https://api.github.com/users/octocat/events{/privacy}" ] }, "received_events_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/users/octocat/received_events"] }, "type": { "type": "string", "examples": ["User"] }, "site_admin": { "type": "boolean" }, "starred_at": { "type": "string", "examples": ["\"2020-07-09T00:17:55Z\""] }, "user_view_type": { "type": "string", "examples": ["public"] } }, "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" ] }, "webhook-branch-protection-configuration-enabled": { "title": "branch protection configuration enabled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-branch-protection-rule-created": { "title": "branch protection rule created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "rule", "repository", "sender"] }, "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-cloud@latest/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"] }, "lock_branch_enforcement_level": { "description": "The enforcement level of the branch lock setting. `off` means the branch is not locked, `non_admins` means the branch is read-only for non_admins, and `everyone` means the branch is read-only for everyone.", "type": "string", "enum": ["off", "non_admins", "everyone"] }, "lock_allows_fork_sync": { "description": "Whether users can pull changes from upstream when the branch is locked. Set to `true` to allow users to pull changes from upstream when the branch is locked. This setting is only applicable for forks.", "type": "boolean" }, "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" }, "require_last_push_approval": { "description": "Whether the most recent push must be approved by someone other than the person who pushed it", "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", "lock_branch_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" ] }, "webhook-branch-protection-rule-deleted": { "title": "branch protection rule deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "rule", "repository", "sender"] }, "webhook-branch-protection-rule-edited": { "title": "branch protection rule edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "description": "If the action was `edited`, the changes to the rule.", "type": "object", "properties": { "admin_enforced": { "type": "object", "properties": { "from": { "type": ["boolean", "null"] } }, "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", "null"] } }, "required": ["from"] }, "authorized_dismissal_actors_only": { "type": "object", "properties": { "from": { "type": ["boolean", "null"] } }, "required": ["from"] }, "linear_history_requirement_enforcement_level": { "type": "object", "properties": { "from": { "type": "string", "enum": ["off", "non_admins", "everyone"] } }, "required": ["from"] }, "lock_branch_enforcement_level": { "type": "object", "properties": { "from": { "type": "string", "enum": ["off", "non_admins", "everyone"] } }, "required": ["from"] }, "lock_allows_fork_sync": { "type": "object", "properties": { "from": { "type": ["boolean", "null"] } }, "required": ["from"] }, "pull_request_reviews_enforcement_level": { "type": "object", "properties": { "from": { "type": "string", "enum": ["off", "non_admins", "everyone"] } }, "required": ["from"] }, "require_last_push_approval": { "type": "object", "properties": { "from": { "type": ["boolean", "null"] } }, "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": { "$ref": "#/components/schemas/webhooks_rule" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "rule", "repository", "sender"] }, "webhook-exemption-request-cancelled": { "title": "Exemption request cancellation event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "exemption_request": { "$ref": "#/components/schemas/exemption-request" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "exemption_request", "sender"] }, "exemption-request": { "title": "Exemption Request", "description": "A request from a user to be exempted from a set of rules.", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the exemption request." }, "number": { "type": "integer", "description": "The number uniquely identifying the exemption request within its repository." }, "repository_id": { "type": "integer", "description": "The ID of the repository the exemption request is for." }, "requester_id": { "type": "integer", "description": "The ID of the user who requested the exemption." }, "requester_login": { "type": "string", "description": "The login of the user who requested the exemption." }, "request_type": { "type": "string", "description": "The type of request.", "enum": [ "push_ruleset_bypass", "secret_scanning", "secret_scanning_closure", "code_scanning_alert_dismissal", "dependabot_alert_dismissal", "license_compliance_dismissal" ] }, "exemption_request_data": { "oneOf": [ { "$ref": "#/components/schemas/exemption-request-push-ruleset-bypass" }, { "$ref": "#/components/schemas/exemption-request-secret-scanning" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning" }, { "$ref": "#/components/schemas/dismissal-request-code-scanning" }, { "$ref": "#/components/schemas/dismissal-request-dependabot" }, { "$ref": "#/components/schemas/dismissal-request-license-compliance" } ] }, "resource_identifier": { "type": "string", "description": "The unique identifier for the request type of the exemption request. For example, a commit SHA.", "examples": ["827efc6d56897b048c772eb4087f854f46256132"] }, "status": { "type": "string", "description": "The status of the exemption request.", "enum": ["pending", "rejected", "cancelled", "completed"] }, "requester_comment": { "type": ["string", "null"], "description": "The comment the requester provided when creating the exemption request." }, "metadata": { "type": ["object", "null"], "description": "Metadata about the exemption request.", "anyOf": [ { "$ref": "#/components/schemas/exemption-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-secret-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-code-scanning-metadata" }, { "$ref": "#/components/schemas/dismissal-request-dependabot-metadata" }, { "$ref": "#/components/schemas/dismissal-request-license-compliance-metadata" } ] }, "expires_at": { "type": "string", "format": "date-time", "description": "The date and time the exemption request will expire." }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time the exemption request was created." }, "responses": { "type": ["array", "null"], "description": "The responses to the exemption request.", "items": { "$ref": "#/components/schemas/exemption-response" } }, "html_url": { "type": "string", "description": "The URL to view the exemption request in a browser.", "format": "uri", "examples": ["https://github.com/monalisa/smile/exemptions/1"] } } }, "exemption-request-push-ruleset-bypass": { "title": "Push ruleset bypass exemption request data", "description": "Push rules that are being requested to be bypassed.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of request", "enum": ["push_ruleset_bypass"] }, "data": { "type": "array", "description": "The data pertaining to the push rules that are being requested to be bypassed.", "items": { "type": "object", "properties": { "ruleset_id": { "type": "integer", "description": "The ID of the ruleset for the rules that were violated" }, "ruleset_name": { "type": "string", "description": "The name of the ruleset for the rules that were violated" }, "total_violations": { "type": "integer", "description": "The number of violations" }, "rule_type": { "type": "string", "description": "The type of rule that was violated" } } } } } }, "exemption-request-secret-scanning": { "title": "Secret scanning push protection exemption request data", "description": "Secret scanning push protections that are being requested to be bypassed.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of request", "enum": ["secret_scanning"] }, "data": { "type": "array", "description": "The data pertaining to the secret scanning push protections that are being requested to be bypassed.", "items": { "type": "object", "properties": { "secret_type": { "type": "string", "description": "The type of secret that was detected" }, "locations": { "type": "array", "description": "The location data of the secret that was detected", "items": { "type": "object", "properties": { "commit": { "type": "string", "description": "The commit SHA where the secret was detected" }, "branch": { "type": "string", "description": "The branch where the secret was detected" }, "path": { "type": "string", "description": "The path of the file where the secret was detected" } } } } } } } } }, "dismissal-request-secret-scanning": { "title": "Secret scanning alert dismissal request data", "description": "Secret scanning alerts that have dismissal requests.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of request", "enum": ["secret_scanning_closure"] }, "data": { "type": "array", "description": "The data related to the secret scanning alerts that have dismissal requests.", "items": { "type": "object", "properties": { "reason": { "type": "string", "description": "The reason for the dismissal request", "enum": ["fixed_later", "false_positive", "tests", "revoked"] }, "secret_type": { "type": "string", "description": "The type of secret that was detected" }, "alert_number": { "type": "string", "description": "The number of the alert that was detected" } } } } } }, "dismissal-request-code-scanning": { "title": "Code scanning alert dismissal request data", "description": "Code scanning alerts that have dismissal requests.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of request", "enum": ["code_scanning_alert_dismissal"] }, "data": { "type": "array", "description": "The data related to the code scanning alerts that have dismissal requests.", "items": { "type": "object", "properties": { "alert_number": { "type": "string", "description": "The number of the alert to be dismissed" } } } } } }, "dismissal-request-dependabot": { "title": "Dependabot alert dismissal request data", "description": "Dependabot alerts that have dismissal requests.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of request", "enum": ["dependabot_alert_dismissal"] }, "data": { "type": "array", "description": "The data related to the Dependabot alerts that have dismissal requests.", "items": { "type": "object", "properties": { "alert_number": { "type": "string", "description": "The number of the alert to be dismissed" } } } } } }, "dismissal-request-license-compliance": { "title": "License compliance alert closure request data", "description": "License compliance alerts that have closure requests.", "type": "object", "properties": { "type": { "type": "string", "description": "The type of request", "enum": ["license_compliance_dismissal"] }, "data": { "type": "array", "description": "The data related to the License compliance alerts that have closure requests.", "items": { "type": "object", "properties": { "alert_number": { "type": "string", "description": "The number of the alert to be closed" } } } } } }, "exemption-request-secret-scanning-metadata": { "title": "Secret Scanning Push Protection Exemption Request Metadata", "description": "Metadata for a secret scanning push protection exemption request.", "type": "object", "properties": { "label": { "type": "string", "description": "The label for the secret type" }, "reason": { "type": "string", "description": "The reason for the exemption request", "enum": ["fixed_later", "false_positive", "tests"] } } }, "dismissal-request-secret-scanning-metadata": { "title": "Secret scanning alert dismissal request metadata", "description": "Metadata for a secret scanning alert dismissal request.", "type": "object", "properties": { "alert_title": { "type": "string", "description": "The title of the secret alert" }, "reason": { "type": "string", "description": "The reason for the dismissal request", "enum": ["fixed_later", "false_positive", "tests", "revoked"] } } }, "dismissal-request-code-scanning-metadata": { "title": "Code scanning alert dismissal request metadata", "description": "Metadata for a code scanning alert dismissal request.", "type": "object", "properties": { "alert_title": { "type": "string", "description": "The title of the code scanning alert" }, "reason": { "type": "string", "description": "The reason for the dismissal request", "enum": ["false positive", "won't fix", "used in tests"] } } }, "dismissal-request-dependabot-metadata": { "title": "Dependabot alert dismissal request metadata", "description": "Metadata for a Dependabot alert dismissal request.", "type": "object", "properties": { "alert_title": { "type": "string", "description": "The title of the Dependabot alert" }, "reason": { "type": "string", "description": "The reason for the dismissal request", "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk" ] } } }, "dismissal-request-license-compliance-metadata": { "title": "License compliance alert closure request metadata", "description": "Metadata for a License compliance alert closure request.", "type": "object", "properties": { "alert_title": { "type": "string", "description": "The title of the License compliance alert" }, "reason": { "type": "string", "description": "The reason for the closure request", "enum": ["amendment", "private package", "inaccurate license"] } } }, "exemption-response": { "title": "Exemption response", "description": "A response to an exemption request by a delegated bypasser.", "type": "object", "properties": { "id": { "type": "integer", "description": "The ID of the exemption response." }, "reviewer_id": { "type": "integer", "description": "The ID of the user who reviewed the exemption request." }, "reviewer_login": { "type": "string", "description": "The login of the user who reviewed the exemption request." }, "status": { "type": "string", "description": "The status of the exemption response.", "enum": ["approved", "rejected", "dismissed"] }, "reviewer_comment": { "type": ["string", "null"], "description": "The comment the reviewer provided when responding to the exemption request." }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time the exemption request was created." } } }, "webhook-exemption-request-completed": { "title": "Exemption request completed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "exemption_request": { "$ref": "#/components/schemas/exemption-request" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "exemption_request", "sender"] }, "webhook-exemption-request-created": { "title": "Exemption request created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "exemption_request": { "$ref": "#/components/schemas/exemption-request" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "exemption_request", "sender"] }, "webhook-exemption-request-response-dismissed": { "title": "Exemption response dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["response_dismissed"] }, "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" }, "exemption_request": { "$ref": "#/components/schemas/exemption-request" }, "exemption_response": { "$ref": "#/components/schemas/exemption-response" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "exemption_request", "exemption_response", "sender" ] }, "webhook-exemption-request-response-submitted": { "title": "Exemption response submitted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["response_submitted"] }, "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" }, "exemption_request": { "$ref": "#/components/schemas/exemption-request" }, "exemption_response": { "$ref": "#/components/schemas/exemption-response" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "exemption_request", "exemption_response", "sender" ] }, "webhook-check-run-completed": { "title": "Check Run Completed Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["completed"] }, "check_run": { "$ref": "#/components/schemas/check-run-with-simple-check-suite" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["check_run", "repository", "sender", "action"] }, "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/integration" }, "check_suite": { "$ref": "#/components/schemas/simple-check-suite" }, "completed_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2018-05-04T01:14:52Z"] }, "conclusion": { "type": ["string", "null"], "enum": [ "waiting", "pending", "startup_failure", "stale", "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", null ], "examples": ["neutral"] }, "deployment": { "$ref": "#/components/schemas/deployment-simple" }, "details_url": { "type": "string", "examples": ["https://example.com"] }, "external_id": { "type": "string", "examples": ["42"] }, "head_sha": { "description": "The SHA of the commit that is being checked.", "type": "string", "examples": ["009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"] }, "html_url": { "type": "string", "examples": ["https://github.com/github/hello-world/runs/4"] }, "id": { "description": "The id of the check.", "type": "integer", "examples": [21] }, "name": { "description": "The name of the check.", "type": "string", "examples": ["test-coverage"] }, "node_id": { "type": "string", "examples": ["MDg6Q2hlY2tSdW40"] }, "output": { "type": "object", "properties": { "annotations_count": { "type": "integer" }, "annotations_url": { "type": "string", "format": "uri" }, "summary": { "type": ["string", "null"] }, "text": { "type": ["string", "null"] }, "title": { "type": ["string", "null"] } }, "required": [ "title", "summary", "text", "annotations_count", "annotations_url" ] }, "pull_requests": { "type": "array", "items": { "$ref": "#/components/schemas/pull-request-minimal" } }, "started_at": { "type": "string", "format": "date-time", "examples": ["2018-05-04T01:14:52Z"] }, "status": { "description": "The phase of the lifecycle that the check is currently in.", "type": "string", "enum": ["queued", "in_progress", "completed", "pending"], "examples": ["queued"] }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-runs/4" ] } }, "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" ] }, "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", "null"], "properties": { "id": { "description": "Unique identifier of the GitHub app", "type": "integer", "examples": [37] }, "slug": { "description": "The slug name of the GitHub app", "type": "string", "examples": ["probot-owners"] }, "node_id": { "type": "string", "examples": ["MDExOkludGVncmF0aW9uMQ=="] }, "client_id": { "type": "string", "examples": ["\"Iv1.25b5d1e65ffc4022\""] }, "owner": { "oneOf": [ { "$ref": "#/components/schemas/simple-user" }, { "$ref": "#/components/schemas/enterprise" } ] }, "name": { "description": "The name of the GitHub app", "type": "string", "examples": ["Probot Owners"] }, "description": { "type": ["string", "null"], "examples": ["The description of the app."] }, "external_url": { "type": "string", "format": "uri", "examples": ["https://example.com"] }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/apps/super-ci"] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2017-07-08T16:18:44-04:00"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["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. Note that the `installation_target`, `security_advisory`, and `meta` events are not included because they are global events and not specific to an installation.", "type": "array", "items": { "type": "string" }, "examples": ["label", "deployment"] }, "installations_count": { "description": "The number of installations associated with the GitHub app. Only returned when the integration is requesting details about itself.", "type": "integer", "examples": [5] } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at", "permissions", "events" ] }, "enterprise": { "title": "Enterprise", "description": "An enterprise on GitHub.", "type": "object", "properties": { "description": { "description": "A short description of the enterprise.", "type": ["string", "null"] }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/enterprises/octo-business"] }, "website_url": { "description": "The enterprise's website URL.", "type": ["string", "null"], "format": "uri" }, "id": { "description": "Unique identifier of the enterprise", "type": "integer", "examples": [42] }, "node_id": { "type": "string", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "description": "The name of the enterprise.", "type": "string", "examples": ["Octo Business"] }, "slug": { "description": "The slug url identifier for the enterprise.", "type": "string", "examples": ["octo-business"] }, "created_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2019-01-26T19:01:12Z"] }, "updated_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2019-01-26T19:14:43Z"] }, "avatar_url": { "type": "string", "format": "uri" } }, "required": [ "id", "node_id", "name", "slug", "html_url", "created_at", "updated_at", "avatar_url" ] }, "simple-check-suite": { "description": "A suite of checks performed on the code of a given code change", "type": "object", "properties": { "after": { "type": ["string", "null"], "examples": ["d6fde92930d4715a2b49857d24b940956b26d2d3"] }, "app": { "$ref": "#/components/schemas/integration" }, "before": { "type": ["string", "null"], "examples": ["146e867f55c26428e5f9fade55a9bbf5e95a7912"] }, "conclusion": { "type": ["string", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "skipped", "timed_out", "action_required", "stale", "startup_failure", null ], "examples": ["neutral"] }, "created_at": { "type": "string", "format": "date-time" }, "head_branch": { "type": ["string", "null"], "examples": ["master"] }, "head_sha": { "description": "The SHA of the head commit that is being checked.", "type": "string", "examples": ["009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d"] }, "id": { "type": "integer", "examples": [5] }, "node_id": { "type": "string", "examples": ["MDEwOkNoZWNrU3VpdGU1"] }, "pull_requests": { "type": "array", "items": { "$ref": "#/components/schemas/pull-request-minimal" } }, "repository": { "$ref": "#/components/schemas/minimal-repository" }, "status": { "type": "string", "enum": [ "queued", "in_progress", "completed", "pending", "waiting" ], "examples": ["completed"] }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "examples": [ "https://api.github.com/repos/github/hello-world/check-suites/5" ] } } }, "pull-request-minimal": { "title": "Pull Request Minimal", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "number": { "type": "integer" }, "url": { "type": "string" }, "head": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "url", "name"] } }, "required": ["ref", "sha", "repo"] }, "base": { "type": "object", "properties": { "ref": { "type": "string" }, "sha": { "type": "string" }, "repo": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "url": { "type": "string" }, "name": { "type": "string" } }, "required": ["id", "url", "name"] } }, "required": ["ref", "sha", "repo"] } }, "required": ["id", "number", "url", "head", "base"] }, "minimal-repository": { "title": "Minimal Repository", "description": "Minimal Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [1296269] }, "node_id": { "type": "string", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "type": "string", "examples": ["Hello-World"] }, "full_name": { "type": "string", "examples": ["octocat/Hello-World"] }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/octocat/Hello-World"] }, "description": { "type": ["string", "null"], "examples": ["This your first repo!"] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/repos/octocat/Hello-World"] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string" }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string" }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": ["http://api.github.com/repos/octocat/Hello-World/tags"] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string" }, "mirror_url": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string" }, "homepage": { "type": ["string", "null"] }, "language": { "type": ["string", "null"] }, "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" }, "has_pull_requests": { "type": "boolean" }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "archived": { "type": "boolean" }, "disabled": { "type": "boolean" }, "visibility": { "type": "string" }, "pushed_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:06:43Z"] }, "created_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "updated_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:14:43Z"] }, "permissions": { "type": "object", "properties": { "admin": { "type": "boolean" }, "maintain": { "type": "boolean" }, "push": { "type": "boolean" }, "triage": { "type": "boolean" }, "pull": { "type": "boolean" } } }, "role_name": { "type": "string", "examples": ["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", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"] }, "node_id": { "type": "string" } } }, "forks": { "type": "integer", "examples": [0] }, "open_issues": { "type": "integer", "examples": [0] }, "watchers": { "type": "integer", "examples": [0] }, "allow_forking": { "type": "boolean" }, "web_commit_signoff_required": { "type": "boolean", "examples": [false] }, "security_and_analysis": { "$ref": "#/components/schemas/security-and-analysis" }, "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 } }, "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" ], "x-github-breaking-changes": [ { "changeset": "remove_has_downloads", "patch": { "properties": { "has_downloads": null } }, "version": "2026-03-10" } ] }, "code-of-conduct": { "title": "Code Of Conduct", "description": "Code Of Conduct", "type": "object", "properties": { "key": { "type": "string", "examples": ["contributor_covenant"] }, "name": { "type": "string", "examples": ["Contributor Covenant"] }, "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/codes_of_conduct/contributor_covenant" ] }, "body": { "type": "string", "examples": [ "# Contributor Covenant Code of Conduct\n\n## Our Pledge\n\nIn the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.\n\n## Our Standards\n\nExamples of behavior that contributes to creating a positive environment include:\n\n* Using welcoming and inclusive language\n* Being respectful of differing viewpoints and experiences\n* Gracefully accepting constructive criticism\n* Focusing on what is best for the community\n* Showing empathy towards other community members\n\nExamples of unacceptable behavior by participants include:\n\n* The use of sexualized language or imagery and unwelcome sexual attention or advances\n* Trolling, insulting/derogatory comments, and personal or political attacks\n* Public or private harassment\n* Publishing others' private information, such as a physical or electronic address, without explicit permission\n* Other conduct which could reasonably be considered inappropriate in a professional setting\n\n## Our Responsibilities\n\nProject maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response\n to any instances of unacceptable behavior.\n\nProject maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.\n\n## Scope\n\nThis Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address,\n posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.\n\n## Enforcement\n\nInstances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at [EMAIL]. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.\n\nProject maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.\n\n## Attribution\n\nThis Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.4, available at [http://contributor-covenant.org/version/1/4](http://contributor-covenant.org/version/1/4/).\n" ] }, "html_url": { "type": ["string", "null"], "format": "uri" } }, "required": ["url", "html_url", "key", "name"] }, "security-and-analysis": { "type": ["object", "null"], "properties": { "advanced_security": { "description": "Enable or disable GitHub Advanced Security for the repository.\n\nFor standalone Code Scanning or Secret Protection products, this parameter cannot be used.\n", "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "code_security": { "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "dependabot_security_updates": { "description": "Enable or disable Dependabot security updates for the repository.", "type": "object", "properties": { "status": { "description": "The enablement status of Dependabot security updates for the repository.", "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"] } } }, "secret_scanning_non_provider_patterns": { "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "secret_scanning_ai_detection": { "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "secret_scanning_validity_checks": { "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "secret_scanning_delegated_alert_dismissal": { "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "secret_scanning_delegated_bypass": { "type": "object", "properties": { "status": { "type": "string", "enum": ["enabled", "disabled"] } } }, "secret_scanning_delegated_bypass_options": { "type": "object", "properties": { "reviewers": { "type": "array", "description": "The bypass reviewers for secret scanning delegated bypass", "items": { "type": "object", "required": ["reviewer_id", "reviewer_type"], "properties": { "reviewer_id": { "type": "integer", "description": "The ID of the team or role selected as a bypass reviewer" }, "reviewer_type": { "type": "string", "description": "The type of the bypass reviewer", "enum": ["TEAM", "ROLE"] }, "mode": { "type": "string", "description": "The bypass mode for the reviewer", "enum": ["ALWAYS", "EXEMPT"], "default": "ALWAYS" } } } } } } } }, "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", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "examples": [42] }, "node_id": { "type": "string", "examples": ["MDEwOkRlcGxveW1lbnQx"] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": ["deploy"] }, "original_environment": { "type": "string", "examples": ["staging"] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": ["production"] }, "description": { "type": ["string", "null"], "examples": ["Deploy request from hubot"] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2012-07-20T01:19:13Z"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["2012-07-20T01:19:13Z"] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": ["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.", "type": "boolean", "examples": [true] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [true] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/integration" } ] } }, "required": [ "id", "node_id", "task", "environment", "description", "statuses_url", "repository_url", "url", "created_at", "updated_at" ] }, "webhook-check-run-created": { "title": "Check Run Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "check_run": { "$ref": "#/components/schemas/check-run-with-simple-check-suite" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["check_run", "repository", "sender", "action"] }, "webhook-check-run-requested-action": { "title": "Check Run Requested Action Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["requested_action"] }, "check_run": { "$ref": "#/components/schemas/check-run-with-simple-check-suite" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "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" } }, "required": ["action", "check_run", "repository", "sender"] }, "webhook-check-run-rerequested": { "title": "Check Run Re-Requested Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["rerequested"] }, "check_run": { "$ref": "#/components/schemas/check-run-with-simple-check-suite" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["check_run", "repository", "sender", "action"] }, "webhook-check-suite-completed": { "title": "check_suite completed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["completed"] }, "check_suite": { "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { "type": ["string", "null"] }, "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", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "client_id": { "description": "The client ID of the GitHub app", "type": ["string", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "format": "date-time" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ] }, "before": { "type": ["string", "null"] }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null, "skipped", "startup_failure" ] }, "created_at": { "type": "string", "format": "date-time" }, "head_branch": { "description": "The head branch name the changes are on.", "type": ["string", "null"] }, "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", "null"], "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", "null"], "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", "null"], "enum": [ "requested", "in_progress", "completed", "queued", null, "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" } }, "required": ["action", "check_suite", "repository", "sender"] }, "webhook-check-suite-requested": { "title": "check_suite requested event", "type": "object", "properties": { "action": { "type": "string", "enum": ["requested"] }, "check_suite": { "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { "type": ["string", "null"] }, "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", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "client_id": { "description": "Client ID of the GitHub app", "type": ["string", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "artifact_metadata": { "type": "string", "enum": ["read", "write"] }, "attestations": { "type": "string", "enum": ["read", "write"] }, "checks": { "type": "string", "enum": ["read", "write"] }, "code_quality": { "type": "string", "enum": ["read", "write"] }, "content_references": { "type": "string", "enum": ["read", "write"] }, "contents": { "type": "string", "enum": ["read", "write"] }, "copilot_requests": { "type": "string", "enum": ["write"] }, "deployments": { "type": "string", "enum": ["read", "write"] }, "discussions": { "type": "string", "enum": ["read", "write"] }, "drives": { "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"] }, "merge_queues": { "type": "string", "enum": ["read", "write"] }, "metadata": { "type": "string", "enum": ["read", "write"] }, "models": { "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"] }, "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", "null"], "format": "date-time" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ] }, "before": { "type": ["string", "null"] }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null, "skipped" ] }, "created_at": { "type": "string", "format": "date-time" }, "head_branch": { "description": "The head branch name the changes are on.", "type": ["string", "null"] }, "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", "null"], "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", "null"], "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", "null"], "enum": [ "requested", "in_progress", "completed", "queued", null ] }, "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" } }, "required": ["action", "check_suite", "repository", "sender"] }, "webhook-check-suite-rerequested": { "title": "check_suite rerequested event", "type": "object", "properties": { "action": { "type": "string", "enum": ["rerequested"] }, "check_suite": { "description": "The [check_suite](https://docs.github.com/enterprise-cloud@latest/rest/checks/suites#get-a-check-suite).", "type": "object", "properties": { "after": { "type": ["string", "null"] }, "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", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "client_id": { "description": "The Client ID for the GitHub app", "type": ["string", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "artifact_metadata": { "type": "string", "enum": ["read", "write"] }, "attestations": { "type": "string", "enum": ["read", "write"] }, "checks": { "type": "string", "enum": ["read", "write"] }, "code_quality": { "type": "string", "enum": ["read", "write"] }, "content_references": { "type": "string", "enum": ["read", "write"] }, "contents": { "type": "string", "enum": ["read", "write"] }, "copilot_requests": { "type": "string", "enum": ["write"] }, "deployments": { "type": "string", "enum": ["read", "write"] }, "discussions": { "type": "string", "enum": ["read", "write"] }, "drives": { "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"] }, "merge_queues": { "type": "string", "enum": ["read", "write"] }, "metadata": { "type": "string", "enum": ["read", "write"] }, "models": { "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"] }, "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", "null"], "format": "date-time" } }, "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ] }, "before": { "type": ["string", "null"] }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, "created_at": { "type": "string", "format": "date-time" }, "head_branch": { "description": "The head branch name the changes are on.", "type": ["string", "null"] }, "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", "null"], "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", "null"], "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", "null"], "enum": [ "requested", "in_progress", "completed", "queued", null ] }, "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" } }, "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"] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"], "format": "date-time" }, "dismissed_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "dismissed_comment": { "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert.", "type": ["string", "null"], "enum": [ "false positive", "won't fix", "used in tests", "mitigated", null ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "html_url": { "description": "The GitHub URL of the alert resource.", "type": "string", "format": "uri" }, "most_recent_instance": { "title": "Alert Instance", "type": ["object", "null"], "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", "null"], "enum": ["none", "note", "warning", "error", null] } }, "required": ["id", "severity", "description"] }, "state": { "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": ["string", "null"], "enum": ["open", "dismissed", "fixed", null] }, "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", "null"] } }, "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": { "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "ref": { "$ref": "#/components/schemas/webhooks_code_scanning_ref" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "alert", "ref", "commit_oid", "repository", "sender" ] }, "code-scanning-alert-dismissed-comment": { "type": ["string", "null"], "description": "The dismissal comment associated with the dismissal of the alert.", "maxLength": 280 }, "webhooks_code_scanning_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" }, "webhooks_code_scanning_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" }, "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"] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "dismissed_comment": { "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert.", "type": ["string", "null"], "enum": [ "false positive", "won't fix", "used in tests", "mitigated", null ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "html_url": { "description": "The GitHub URL of the alert resource.", "type": "string", "format": "uri" }, "most_recent_instance": { "title": "Alert Instance", "type": ["object", "null"], "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", "null"] }, "help_uri": { "description": "A link to the documentation for the rule used to detect the alert.", "type": ["string", "null"] }, "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", "null"], "enum": ["none", "note", "warning", "error", null] }, "tags": { "type": ["array", "null"], "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", "null"] }, "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", "null"] } }, "required": ["name", "version"] }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": [ "number", "created_at", "url", "html_url", "state", "dismissed_by", "dismissed_at", "dismissed_reason", "rule", "tool" ] }, "commit_oid": { "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "ref": { "$ref": "#/components/schemas/webhooks_code_scanning_ref" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "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", "null"], "format": "date-time" }, "dismissed_at": { "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "dismissed_by": { "type": ["null"] }, "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`, `used in tests`, and `mitigated`.", "type": ["null"] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "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", "null"], "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", "null"] }, "help_uri": { "description": "A link to the documentation for the rule used to detect the alert.", "type": ["string", "null"] }, "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", "null"], "enum": ["none", "note", "warning", "error", null] }, "tags": { "type": ["array", "null"], "items": { "type": "string" } } }, "required": ["id", "severity", "description"] }, "state": { "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": ["string", "null"], "enum": ["open", "dismissed", null] }, "tool": { "type": ["object", "null"], "properties": { "guid": { "type": ["string", "null"] }, "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", "null"] } }, "required": ["name", "version"] }, "updated_at": { "type": ["string", "null"] }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { "type": ["null"] }, "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } } }, "required": [ "number", "created_at", "url", "html_url", "state", "dismissed_by", "dismissed_at", "dismissed_reason", "rule", "tool" ] }, "commit_oid": { "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "ref": { "$ref": "#/components/schemas/webhooks_code_scanning_ref" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"], "format": "date-time" }, "dismissed_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "dismissed_comment": { "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert.", "type": ["string", "null"], "enum": [ "false positive", "won't fix", "used in tests", "mitigated", null ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "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", "null"], "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", "null"] }, "help_uri": { "description": "A link to the documentation for the rule used to detect the alert.", "type": ["string", "null"] }, "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", "null"], "enum": ["none", "note", "warning", "error", null] }, "tags": { "type": ["array", "null"], "items": { "type": "string" } } }, "required": ["id", "severity", "description"] }, "state": { "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": ["string", "null"], "enum": ["fixed", null] }, "tool": { "type": "object", "properties": { "guid": { "type": ["string", "null"] }, "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", "null"] } }, "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": { "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "ref": { "$ref": "#/components/schemas/webhooks_code_scanning_ref" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"] }, "dismissed_by": { "type": ["object", "null"] }, "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`, `used in tests`, and `mitigated`.", "type": ["string", "null"] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "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", "null"], "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", "null"] }, "help_uri": { "description": "A link to the documentation for the rule used to detect the alert.", "type": ["string", "null"] }, "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", "null"], "enum": ["none", "note", "warning", "error", null] }, "tags": { "type": ["array", "null"], "items": { "type": "string" } } }, "required": ["id", "severity", "description"] }, "state": { "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": ["string", "null"], "enum": ["open", "dismissed", "fixed", null] }, "tool": { "type": "object", "properties": { "guid": { "type": ["string", "null"] }, "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", "null"] } }, "required": ["name", "version"] }, "updated_at": { "type": ["string", "null"] }, "url": { "type": "string", "format": "uri" }, "dismissal_approved_by": { "type": ["null"] } }, "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", "null"] }, "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", "null"] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "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": ["null"] }, "dismissed_by": { "type": ["null"] }, "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`, `used in tests`, and `mitigated`.", "type": ["null"] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "html_url": { "description": "The GitHub URL of the alert resource.", "type": "string", "format": "uri" }, "most_recent_instance": { "title": "Alert Instance", "type": ["object", "null"], "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", "null"], "enum": ["none", "note", "warning", "error", null] } }, "required": ["id", "severity", "description"] }, "state": { "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": ["string", "null"], "enum": ["open", "fixed", null] }, "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", "null"] } }, "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": { "$ref": "#/components/schemas/webhooks_code_scanning_commit_oid" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "ref": { "$ref": "#/components/schemas/webhooks_code_scanning_ref" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "alert", "ref", "commit_oid", "repository", "sender" ] }, "webhook-code-scanning-alert-updated-assignment": { "title": "code_scanning_alert updated_assignment event", "type": "object", "properties": { "action": { "type": "string", "enum": ["updated_assignment"] }, "alert": { "description": "The code scanning alert involved in the event.", "type": "object", "properties": { "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"], "format": "date-time" }, "dismissed_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "dismissed_comment": { "$ref": "#/components/schemas/code-scanning-alert-dismissed-comment" }, "dismissed_reason": { "description": "The reason for dismissing or closing the alert.", "type": ["string", "null"], "enum": [ "false positive", "won't fix", "used in tests", "mitigated", null ] }, "fixed_at": { "description": "The time that the alert was fixed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "type": ["null"] }, "html_url": { "description": "The GitHub URL of the alert resource.", "type": "string", "format": "uri" }, "most_recent_instance": { "title": "Alert Instance", "type": ["object", "null"], "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", "null"], "enum": ["none", "note", "warning", "error", null] } }, "required": ["id", "severity", "description"] }, "state": { "description": "State of a code scanning alert. Events for alerts found outside the default branch will return a `null` value until they are dismissed or fixed.", "type": ["string", "null"], "enum": ["open", "dismissed", "fixed", null] }, "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", "null"] } }, "required": ["name", "version"] }, "url": { "type": "string", "format": "uri" } }, "required": [ "number", "created_at", "url", "html_url", "state", "dismissed_by", "dismissed_at", "dismissed_reason", "rule", "tool" ] }, "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" } }, "required": ["action", "alert", "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"] }, "comment": { "description": "The [commit comment](${externalDocsUpapp/api/description/components/schemas/webhooks/issue-comment-created.yamlrl}/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", "null"] }, "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", "null"] }, "position": { "description": "The line index in the diff to which the comment applies.", "type": ["integer", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" } }, "required": ["action", "comment", "repository", "sender"] }, "webhook-create": { "title": "create event", "type": "object", "properties": { "description": { "description": "The repository's current description.", "type": ["string", "null"] }, "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" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pusher_type": { "$ref": "#/components/schemas/webhooks_deploy_pusher_type" }, "ref": { "$ref": "#/components/schemas/webhooks_ref_0" }, "ref_type": { "description": "The type of Git ref object created in the repository.", "type": "string", "enum": ["tag", "branch"] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "ref", "ref_type", "master_branch", "description", "pusher_type", "repository", "sender" ] }, "webhooks_deploy_pusher_type": { "description": "The pusher type for the event. Can be either `user` or a deploy key.", "type": "string" }, "webhooks_ref_0": { "description": "The [`git ref`](https://docs.github.com/enterprise-cloud@latest/rest/git/refs#get-a-reference) resource.", "type": "string" }, "webhook-custom-property-created": { "title": "custom property created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "definition": { "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition"] }, "custom-property": { "title": "Organization Custom Property", "description": "Custom property defined on an organization", "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property" }, "url": { "type": "string", "format": "uri", "description": "The URL that can be used to fetch, update, or delete info about this property via the API." }, "source_type": { "type": "string", "description": "The source type of the property", "enum": ["organization", "enterprise"], "examples": ["organization"] }, "value_type": { "type": "string", "enum": [ "string", "single_select", "multi_select", "true_false", "url" ], "description": "The type of the value for the property", "examples": ["single_select"] }, "required": { "type": "boolean", "description": "Whether the property is required." }, "default_value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Default value of the property", "type": ["null", "string", "array"] }, "description": { "type": ["string", "null"], "description": "Short description of the property" }, "allowed_values": { "type": ["array", "null"], "items": { "type": "string" }, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." }, "values_editable_by": { "type": ["string", "null"], "enum": ["org_actors", "org_and_repo_actors", null], "description": "Who can edit the values of the property", "examples": ["org_actors"] }, "require_explicit_values": { "type": "boolean", "description": "Whether setting properties values is mandatory" } }, "required": ["property_name", "value_type"] }, "webhook-custom-property-deleted": { "title": "custom property deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "definition": { "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property that was deleted." } }, "required": ["property_name"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition"] }, "webhook-custom-property-promoted-to-enterprise": { "title": "custom property promoted to business event", "type": "object", "properties": { "action": { "type": "string", "enum": ["promote_to_enterprise"] }, "definition": { "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition"] }, "webhook-custom-property-updated": { "title": "custom property updated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["updated"] }, "definition": { "$ref": "#/components/schemas/custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition"] }, "webhook-custom-property-values-updated": { "title": "Custom property values updated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["updated"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "new_property_values": { "type": "array", "description": "The new custom property values for the repository.", "items": { "$ref": "#/components/schemas/custom-property-value" } }, "old_property_values": { "type": "array", "description": "The old custom property values for the repository.", "items": { "$ref": "#/components/schemas/custom-property-value" } } }, "required": [ "action", "repository", "organization", "new_property_values", "old_property_values" ] }, "custom-property-value": { "title": "Custom Property Value", "description": "Custom property name and associated value", "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property" }, "value": { "oneOf": [ { "type": ["string", "null"] }, { "type": "array", "items": { "type": "string" } } ], "description": "The value assigned to the property", "type": ["null", "string", "array"] } }, "required": ["property_name", "value"] }, "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": { "$ref": "#/components/schemas/webhooks_deploy_pusher_type" }, "ref": { "$ref": "#/components/schemas/webhooks_ref_0" }, "ref_type": { "description": "The type of Git ref object deleted in the repository.", "type": "string", "enum": ["tag", "branch"] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["ref", "ref_type", "pusher_type", "repository", "sender"] }, "webhook-dependabot-alert-assignees-changed": { "title": "Dependabot alert assignees changed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["assignees_changed"] }, "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" } }, "required": ["action", "alert", "repository", "sender"] }, "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"] }, "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", "null"], "description": "The execution scope of the vulnerable dependency.", "readOnly": true, "enum": ["development", "runtime", null] }, "relationship": { "type": ["string", "null"], "description": "The vulnerable dependency's relationship to your project.\n\n> [!NOTE]\n> We are rolling out support for dependency relationship across ecosystems. This value will be \"unknown\" for all dependencies in unsupported ecosystems.\n", "readOnly": true, "enum": [ "unknown", "direct", "transitive", "inconclusive", null ] } } }, "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": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "dismissed_reason": { "type": ["string", "null"], "description": "The reason that the alert was dismissed.", "enum": [ "fix_started", "inaccurate", "no_bandwidth", "not_used", "tolerable_risk", null ] }, "dismissed_comment": { "type": ["string", "null"], "description": "An optional comment associated with the alert's dismissal.", "maxLength": 280 }, "fixed_at": { "$ref": "#/components/schemas/alert-fixed-at" }, "auto_dismissed_at": { "$ref": "#/components/schemas/alert-auto-dismissed-at" }, "dismissal_request": { "$ref": "#/components/schemas/dependabot-alert-dismissal-request-simple" }, "assignees": { "type": "array", "description": "The users assigned to this alert.", "readOnly": true, "items": { "$ref": "#/components/schemas/simple-user" } } }, "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 }, "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 }, "name": { "type": "string", "description": "The unique package name within its ecosystem.", "readOnly": true } }, "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 }, "cve_id": { "type": ["string", "null"], "description": "The unique CVE ID assigned to the advisory.", "readOnly": true }, "summary": { "type": "string", "description": "A short, plain text summary of the advisory.", "readOnly": true, "maxLength": 1024 }, "description": { "type": "string", "description": "A long-form Markdown-supported description of the advisory.", "readOnly": true }, "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"] }, "classification": { "type": "string", "description": "The classification of the advisory.", "readOnly": true, "enum": ["general", "malware"] }, "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", "null"], "description": "The full CVSS vector string for the advisory.", "readOnly": true } }, "required": ["score", "vector_string"], "additionalProperties": false }, "cvss_severities": { "$ref": "#/components/schemas/cvss-severities" }, "epss": { "$ref": "#/components/schemas/security-advisory-epss" }, "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 }, "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 }, "withdrawn_at": { "type": ["string", "null"], "description": "The time that the advisory was withdrawn in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true } }, "required": [ "ghsa_id", "cve_id", "summary", "description", "vulnerabilities", "severity", "cvss", "cwes", "identifiers", "references", "published_at", "updated_at", "withdrawn_at" ], "additionalProperties": false, "x-github-breaking-changes": [ { "changeset": "deprecate_cvss", "patch": { "properties": { "cvss": null }, "required": [ "ghsa_id", "cve_id", "summary", "description", "vulnerabilities", "severity", "cwes", "identifiers", "references", "published_at", "updated_at", "withdrawn_at" ] }, "version": "2026-03-10" } ] }, "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"] }, "vulnerable_version_range": { "type": "string", "description": "Conditions that identify vulnerable versions of this vulnerability's package.", "readOnly": true }, "first_patched_version": { "type": ["object", "null"], "description": "Details pertaining to the package version that patches this vulnerability.", "readOnly": true, "properties": { "identifier": { "type": "string", "description": "The package version that patches this vulnerability.", "readOnly": true } }, "required": ["identifier"], "additionalProperties": false } }, "required": [ "package", "severity", "vulnerable_version_range", "first_patched_version" ], "additionalProperties": false }, "cvss-severities": { "type": ["object", "null"], "properties": { "cvss_v3": { "type": ["object", "null"], "properties": { "vector_string": { "type": ["string", "null"], "description": "The CVSS 3 vector string." }, "score": { "type": ["number", "null"], "description": "The CVSS 3 score.", "minimum": 0, "maximum": 10, "readOnly": true } }, "required": ["vector_string", "score"] }, "cvss_v4": { "type": ["object", "null"], "properties": { "vector_string": { "type": ["string", "null"], "description": "The CVSS 4 vector string." }, "score": { "type": ["number", "null"], "description": "The CVSS 4 score.", "minimum": 0, "maximum": 10, "readOnly": true } }, "required": ["vector_string", "score"] } } }, "security-advisory-epss": { "type": ["object", "null"], "readOnly": true, "description": "The EPSS scores as calculated by the [Exploit Prediction Scoring System](https://www.first.org/epss).", "properties": { "percentage": { "type": "number", "minimum": 0, "maximum": 100 }, "percentile": { "type": "number", "minimum": 0, "maximum": 100 } } }, "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", "null"], "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "alert-fixed-at": { "type": ["string", "null"], "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 }, "alert-auto-dismissed-at": { "type": ["string", "null"], "description": "The time that the alert was auto-dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", "readOnly": true }, "dependabot-alert-dismissal-request-simple": { "title": "Dependabot alert dismissal request", "description": "Information about an active dismissal request for this Dependabot alert.", "type": ["object", "null"], "properties": { "id": { "type": "integer", "description": "The unique identifier of the dismissal request." }, "status": { "type": "string", "description": "The current status of the dismissal request.", "enum": ["pending", "approved", "rejected", "cancelled"] }, "requester": { "type": "object", "description": "The user who requested the dismissal.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the user." }, "login": { "type": "string", "description": "The login name of the user." } } }, "created_at": { "type": "string", "format": "date-time", "description": "The date and time when the dismissal request was created." }, "url": { "type": "string", "format": "uri", "description": "The API URL to get more information about this dismissal request." } } }, "webhook-dependabot-alert-auto-dismissed": { "title": "Dependabot alert auto-dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["auto_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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-dependabot-alert-auto-reopened": { "title": "Dependabot alert auto-reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["auto_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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-dependabot-alert-created": { "title": "Dependabot alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-dependabot-alert-dismissed": { "title": "Dependabot alert dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-dependabot-alert-fixed": { "title": "Dependabot alert fixed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-dependabot-alert-reintroduced": { "title": "Dependabot alert reintroduced event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-dependabot-alert-reopened": { "title": "Dependabot alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-deploy-key-created": { "title": "deploy_key created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "key": { "$ref": "#/components/schemas/webhooks_deploy_key" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "key", "repository", "sender"] }, "webhooks_deploy_key": { "description": "The [`deploy key`](https://docs.github.com/enterprise-cloud@latest/rest/deploy-keys/deploy-keys#get-a-deploy-key) resource.", "type": "object", "properties": { "added_by": { "type": ["string", "null"] }, "created_at": { "type": "string" }, "id": { "type": "integer" }, "key": { "type": "string" }, "last_used": { "type": ["string", "null"] }, "read_only": { "type": "boolean" }, "title": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "verified": { "type": "boolean" }, "enabled": { "type": "boolean" } }, "required": [ "id", "key", "url", "title", "verified", "created_at", "read_only" ] }, "webhook-deploy-key-deleted": { "title": "deploy_key deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "key": { "$ref": "#/components/schemas/webhooks_deploy_key" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "key", "repository", "sender"] }, "webhook-deployment-created": { "title": "deployment created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "deployment": { "title": "Deployment", "description": "The [deployment](https://docs.github.com/enterprise-cloud@latest/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { "type": "string" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" }, "workflow_run": { "title": "Deployment Workflow Run", "type": ["object", "null"], "properties": { "actor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, "created_at": { "type": "string", "format": "date-time" }, "display_title": { "type": "string" }, "event": { "type": "string" }, "head_branch": { "type": "string" }, "head_commit": { "type": ["null"] }, "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": ["null"] }, "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": ["null"] }, "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", "null"], "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": ["null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhooks_workflow": { "title": "Workflow", "type": ["object", "null"], "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" ] }, "webhook-deployment-protection-rule-requested": { "title": "deployment protection rule requested event", "type": "object", "properties": { "action": { "type": "string", "enum": ["requested"] }, "environment": { "description": "The name of the environment that has the deployment protection rule.", "type": "string" }, "event": { "description": "The event that triggered the deployment protection rule.", "type": "string" }, "deployment_callback_url": { "description": "The URL to review the deployment protection rule.", "type": "string", "format": "uri" }, "deployment": { "$ref": "#/components/schemas/deployment" }, "pull_requests": { "type": "array", "items": { "$ref": "#/components/schemas/pull-request" } }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "repository", "sender"] }, "deployment": { "title": "Deployment", "description": "A request for a specific ref(branch,sha,tag) to be deployed", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1" ] }, "id": { "description": "Unique identifier of the deployment", "type": "integer", "format": "int64", "examples": [42] }, "node_id": { "type": "string", "examples": ["MDEwOkRlcGxveW1lbnQx"] }, "sha": { "type": "string", "examples": ["a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d"] }, "ref": { "description": "The ref to deploy. This can be a branch, tag, or sha.", "type": "string", "examples": ["topic-branch"] }, "task": { "description": "Parameter to specify a task to execute", "type": "string", "examples": ["deploy"] }, "payload": { "oneOf": [ { "type": "object", "additionalProperties": true }, { "type": "string" } ] }, "original_environment": { "type": "string", "examples": ["staging"] }, "environment": { "description": "Name for the target deployment environment.", "type": "string", "examples": ["production"] }, "description": { "type": ["string", "null"], "examples": ["Deploy request from hubot"] }, "creator": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2012-07-20T01:19:13Z"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["2012-07-20T01:19:13Z"] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/example/deployments/1/statuses" ] }, "repository_url": { "type": "string", "format": "uri", "examples": ["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.", "type": "boolean", "examples": [true] }, "production_environment": { "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", "type": "boolean", "examples": [true] }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/integration" } ] } }, "required": [ "id", "node_id", "sha", "ref", "task", "environment", "creator", "payload", "description", "statuses_url", "repository_url", "url", "created_at", "updated_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", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347" ] }, "id": { "type": "integer", "format": "int64", "examples": [1] }, "node_id": { "type": "string", "examples": ["MDExOlB1bGxSZXF1ZXN0MQ=="] }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/octocat/Hello-World/pull/1347"] }, "diff_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.diff" ] }, "patch_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/pull/1347.patch" ] }, "issue_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "commits_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/commits" ] }, "review_comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/1347/comments" ] }, "review_comment_url": { "type": "string", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments{/number}" ] }, "comments_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" ] }, "statuses_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/6dcb09b5b57875f334f61aebed695e2e4193db5e" ] }, "number": { "description": "Number uniquely identifying the pull request within its repository.", "type": "integer", "examples": [42] }, "state": { "description": "State of this Pull Request. Either `open` or `closed`.", "enum": ["open", "closed"], "type": "string", "examples": ["open"] }, "locked": { "type": "boolean", "examples": [true] }, "title": { "description": "The title of the pull request.", "type": "string", "examples": ["Amazing new feature"] }, "user": { "$ref": "#/components/schemas/simple-user" }, "body": { "type": ["string", "null"], "examples": ["Please pull these awesome changes"] }, "labels": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string" }, "name": { "type": "string" }, "description": { "type": ["string", "null"] }, "color": { "type": "string" }, "default": { "type": "boolean" }, "archived_by": { "description": "The user who archived the label, or `null` if it has not been archived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default", "archived_at", "archived_by" ] } }, "milestone": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/milestone" } ] }, "active_lock_reason": { "type": ["string", "null"], "examples": ["too heated"] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "closed_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "merged_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "merge_commit_sha": { "type": ["string", "null"], "examples": ["e5bd3914e2e596debea16f433f57875b5b90bcd6"] }, "assignee": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "requested_reviewers": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "requested_teams": { "type": "array", "items": { "$ref": "#/components/schemas/team-simple" } }, "head": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { "$ref": "#/components/schemas/simple-user" } }, "required": ["label", "ref", "repo", "sha", "user"] }, "base": { "type": "object", "properties": { "label": { "type": "string" }, "ref": { "type": "string" }, "repo": { "$ref": "#/components/schemas/repository" }, "sha": { "type": "string" }, "user": { "$ref": "#/components/schemas/simple-user" } }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "draft": { "description": "Indicates whether or not the pull request is a draft.", "type": "boolean", "examples": [false] }, "merged": { "type": "boolean" }, "mergeable": { "type": ["boolean", "null"], "examples": [true] }, "rebaseable": { "type": ["boolean", "null"], "examples": [true] }, "mergeable_state": { "type": "string", "examples": ["clean"] }, "merged_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "comments": { "type": "integer", "examples": [10] }, "review_comments": { "type": "integer", "examples": [0] }, "maintainer_can_modify": { "description": "Indicates whether maintainers can modify the pull request.", "type": "boolean", "examples": [true] }, "commits": { "type": "integer", "examples": [3] }, "additions": { "type": "integer", "examples": [100] }, "deletions": { "type": "integer", "examples": [3] }, "changed_files": { "type": "integer", "examples": [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" ], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": { "properties": { "merge_commit_sha": null }, "required": [ "_links", "assignee", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "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" ] }, "version": "2026-03-10" }, { "changeset": "remove_singular_assignee_from_issues_and_pull_requests", "patch": { "properties": { "assignee": null }, "required": [ "_links", "labels", "base", "body", "closed_at", "comments_url", "commits_url", "created_at", "diff_url", "head", "html_url", "id", "node_id", "issue_url", "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" ] }, "version": "2026-03-10" } ] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1" ] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/octocat/Hello-World/milestones/v1.0" ] }, "labels_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" ] }, "id": { "type": "integer", "examples": [1002604] }, "node_id": { "type": "string", "examples": ["MDk6TWlsZXN0b25lMTAwMjYwNA=="] }, "number": { "description": "The number of the milestone.", "type": "integer", "examples": [42] }, "state": { "description": "The state of the milestone.", "type": "string", "enum": ["open", "closed"], "default": "open", "examples": ["open"] }, "title": { "description": "The title of the milestone.", "type": "string", "examples": ["v1.0"] }, "description": { "type": ["string", "null"], "examples": ["Tracking milestone for version 1.0"] }, "creator": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "open_issues": { "type": "integer", "examples": [4] }, "closed_issues": { "type": "integer", "examples": [8] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2011-04-10T20:09:31Z"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["2014-03-03T18:58:10Z"] }, "closed_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2013-02-12T13:22:01Z"] }, "due_on": { "type": ["string", "null"], "format": "date-time", "examples": ["2012-10-09T23:39:01Z"] } }, "required": [ "closed_issues", "creator", "description", "due_on", "closed_at", "id", "node_id", "labels_url", "html_url", "number", "open_issues", "state", "title", "url", "created_at", "updated_at" ] }, "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", "examples": [1] }, "node_id": { "type": "string", "examples": ["MDQ6VGVhbTE="] }, "url": { "description": "URL for the team", "type": "string", "format": "uri", "examples": ["https://api.github.com/organizations/1/team/1"] }, "members_url": { "type": "string", "examples": [ "https://api.github.com/organizations/1/team/1/members{/member}" ] }, "name": { "description": "Name of the team", "type": "string", "examples": ["Justice League"] }, "description": { "description": "Description of the team", "type": ["string", "null"], "examples": ["A great team."] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string", "examples": ["admin"] }, "privacy": { "description": "The level of privacy this team should have", "type": "string", "examples": ["closed"] }, "notification_setting": { "description": "The notification setting the team has set", "type": "string", "examples": ["notifications_enabled"] }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/orgs/rails/teams/core"] }, "repositories_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/organizations/1/team/1/repos"] }, "slug": { "type": "string", "examples": ["justice-league"] }, "ldap_dn": { "description": "Distinguished Name (DN) that team maps to within LDAP environment", "type": "string", "examples": ["uid=example,ou=users,dc=github,dc=com"] }, "type": { "description": "The ownership type of the team", "type": "string", "enum": ["enterprise", "organization"] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [37] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [42] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "type" ] }, "repository": { "title": "Repository", "description": "A repository on GitHub.", "type": "object", "properties": { "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64", "examples": [42] }, "node_id": { "type": "string", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "description": "The name of the repository.", "type": "string", "examples": ["Team Environment"] }, "full_name": { "type": "string", "examples": ["octocat/Hello-World"] }, "license": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/license-simple" } ] }, "forks": { "type": "integer" }, "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" }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/octocat/Hello-World"] }, "description": { "type": ["string", "null"], "examples": ["This your first repo!"] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/repos/octocat/Hello-World"] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": ["git:github.com/octocat/Hello-World.git"] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": ["git@github.com:octocat/Hello-World.git"] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": ["http://api.github.com/repos/octocat/Hello-World/tags"] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": ["https://github.com/octocat/Hello-World.git"] }, "mirror_url": { "type": ["string", "null"], "format": "uri", "examples": ["git:git.example.com/octocat/Hello-World"] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": ["https://svn.github.com/octocat/Hello-World"] }, "homepage": { "type": ["string", "null"], "format": "uri", "examples": ["https://github.com"] }, "language": { "type": ["string", "null"] }, "forks_count": { "type": "integer", "examples": [9] }, "stargazers_count": { "type": "integer", "examples": [80] }, "watchers_count": { "type": "integer", "examples": [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", "examples": [108] }, "default_branch": { "description": "The default branch of the repository.", "type": "string", "examples": ["master"] }, "open_issues_count": { "type": "integer", "examples": [0] }, "is_template": { "description": "Whether this repository acts as a template that can be used to generate new repositories.", "default": false, "type": "boolean", "examples": [true] }, "topics": { "type": "array", "items": { "type": "string" } }, "has_issues": { "description": "Whether issues are enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_projects": { "description": "Whether projects are enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_wiki": { "description": "Whether the wiki is enabled.", "default": true, "type": "boolean", "examples": [true] }, "has_pages": { "type": "boolean" }, "has_downloads": { "description": "Whether downloads are enabled.", "default": true, "type": "boolean", "deprecated": true, "examples": [true] }, "has_discussions": { "description": "Whether discussions are enabled.", "default": false, "type": "boolean", "examples": [true] }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "default": true, "type": "boolean", "examples": [true] }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"], "examples": ["all"] }, "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", "null"], "format": "date-time", "examples": ["2011-01-26T19:06:43Z"] }, "created_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "updated_at": { "type": ["string", "null"], "format": "date-time", "examples": ["2011-01-26T19:14:43Z"] }, "allow_rebase_merge": { "description": "Whether to allow rebase merges for pull requests.", "default": true, "type": "boolean", "examples": [true] }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { "description": "Whether to allow squash merges for pull requests.", "default": true, "type": "boolean", "examples": [true] }, "allow_auto_merge": { "description": "Whether to allow Auto-merge to be used on pull requests.", "default": false, "type": "boolean", "examples": [false] }, "delete_branch_on_merge": { "description": "Whether to delete head branches when pull requests are merged", "default": false, "type": "boolean", "examples": [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", "examples": [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 is closing down. 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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name)." }, "merge_commit_message": { "type": "string", "enum": ["PR_BODY", "PR_TITLE", "BLANK"], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message." }, "allow_merge_commit": { "description": "Whether to allow merge commits for pull requests.", "default": true, "type": "boolean", "examples": [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", "examples": ["\"2020-07-09T00:17:42Z\""] }, "anonymous_access_enabled": { "type": "boolean", "description": "Whether anonymous git access is enabled for this repository" }, "code_search_index_status": { "type": "object", "description": "The status of the code search index for this repository", "properties": { "lexical_search_ok": { "type": "boolean" }, "lexical_commit_sha": { "type": "string" } } } }, "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" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": { "properties": { "use_squash_pr_title_as_default": null } }, "version": "2026-03-10" }, { "changeset": "deprecate_beta_media_type", "patch": { "properties": { "master_branch": null } }, "version": "2026-03-10" }, { "changeset": "remove_has_downloads", "patch": { "properties": { "has_downloads": null }, "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", "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" ] }, "version": "2026-03-10" } ] }, "link": { "title": "Link", "description": "Hypermedia Link", "type": "object", "properties": { "href": { "type": "string" } }, "required": ["href"] }, "author-association": { "title": "author_association", "type": "string", "description": "How the author is associated with the repository.", "enum": [ "COLLABORATOR", "CONTRIBUTOR", "FIRST_TIMER", "FIRST_TIME_CONTRIBUTOR", "MANNEQUIN", "MEMBER", "NONE", "OWNER" ], "examples": ["OWNER"] }, "auto-merge": { "title": "Auto merge", "description": "The status of auto merging a pull request.", "type": ["object", "null"], "properties": { "enabled_by": { "$ref": "#/components/schemas/simple-user" }, "merge_method": { "type": "string", "description": "The merge method to use.", "enum": ["merge", "squash", "rebase"] }, "commit_title": { "type": "string", "description": "Title for the merge commit message." }, "commit_message": { "type": "string", "description": "Commit message for the merge commit." } }, "required": [ "enabled_by", "merge_method", "commit_title", "commit_message" ] }, "pull-request-stack": { "title": "Pull Request Stack", "description": "The stack information associated with a pull request.", "type": ["object", "null"], "properties": { "base": { "type": "object", "properties": { "ref": { "type": "string", "description": "The base ref of the stack this pull request belongs to." }, "sha": { "type": "string", "description": "The base SHA of the stack this pull request belongs to." } }, "required": ["ref", "sha"] }, "size": { "type": "integer", "description": "The total number of pull requests in the stack." }, "position": { "type": "integer", "description": "The one-based position of this pull request within the stack, where 1 is the bottom of the stack." }, "id": { "type": "integer", "description": "The ID of the stack that this pull request belongs to." }, "number": { "type": "integer", "description": "The number of the stack that this pull request belongs to." } }, "required": ["base"] }, "webhook-deployment-review-approved": { "type": "object", "properties": { "action": { "type": "string", "enum": ["approved"] }, "approver": { "$ref": "#/components/schemas/webhooks_approver" }, "comment": { "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" }, "reviewers": { "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" }, "workflow_job_run": { "$ref": "#/components/schemas/webhooks_workflow_job_run" }, "workflow_job_runs": { "type": "array", "items": { "type": "object", "properties": { "conclusion": { "type": ["null"] }, "created_at": { "type": "string" }, "environment": { "type": "string" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": ["string", "null"] }, "status": { "type": "string" }, "updated_at": { "type": "string" } } } }, "workflow_run": { "title": "Deployment Workflow Run", "type": ["object", "null"], "properties": { "actor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, "created_at": { "type": "string", "format": "date-time" }, "display_title": { "type": "string" }, "event": { "type": "string" }, "head_branch": { "type": "string" }, "head_commit": { "type": ["object", "null"] }, "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", "null"] }, "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" }, "user_view_type": { "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", "null"] }, "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", "null"], "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", "null"] }, "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" }, "user_view_type": { "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhooks_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" }, "user_view_type": { "type": "string" } } }, "webhooks_reviewers": { "type": "array", "items": { "type": "object", "properties": { "reviewer": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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"] } } } }, "webhooks_workflow_job_run": { "type": "object", "properties": { "conclusion": { "type": ["null"] }, "created_at": { "type": "string" }, "environment": { "type": "string" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": ["null"] }, "status": { "type": "string" }, "updated_at": { "type": "string" } }, "required": [ "id", "name", "status", "conclusion", "html_url", "created_at", "updated_at", "environment" ] }, "webhook-deployment-review-rejected": { "type": "object", "properties": { "action": { "type": "string", "enum": ["rejected"] }, "approver": { "$ref": "#/components/schemas/webhooks_approver" }, "comment": { "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" }, "reviewers": { "$ref": "#/components/schemas/webhooks_reviewers" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" }, "workflow_job_run": { "$ref": "#/components/schemas/webhooks_workflow_job_run" }, "workflow_job_runs": { "type": "array", "items": { "type": "object", "properties": { "conclusion": { "type": ["string", "null"] }, "created_at": { "type": "string" }, "environment": { "type": "string" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": ["string", "null"] }, "status": { "type": "string" }, "updated_at": { "type": "string" } } } }, "workflow_run": { "title": "Deployment Workflow Run", "type": ["object", "null"], "properties": { "actor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, "created_at": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "head_branch": { "type": "string" }, "head_commit": { "type": ["object", "null"] }, "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", "null"] }, "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" }, "user_view_type": { "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", "null"] }, "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", "null"], "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", "null"] }, "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" }, "user_view_type": { "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "environment": { "type": "string" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "requestor": { "$ref": "#/components/schemas/webhooks_user" }, "reviewers": { "type": "array", "items": { "type": "object", "properties": { "reviewer": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["id"] }, "type": { "type": "string", "enum": ["User", "Team"] } } } }, "sender": { "$ref": "#/components/schemas/simple-user" }, "since": { "type": "string" }, "workflow_job_run": { "type": "object", "properties": { "conclusion": { "type": ["null"] }, "created_at": { "type": "string" }, "environment": { "type": "string" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": ["string", "null"] }, "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", "null"], "properties": { "actor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null ] }, "created_at": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "head_branch": { "type": "string" }, "head_commit": { "type": ["object", "null"] }, "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", "null"] }, "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" }, "user_view_type": { "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", "null"] }, "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", "null"], "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", "null"] }, "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" }, "user_view_type": { "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhooks_user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "webhook-deployment-status-created": { "title": "deployment_status created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "check_run": { "type": ["object", "null"], "properties": { "completed_at": { "type": ["string", "null"], "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", "skipped", null ] }, "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-cloud@latest/rest/deployments/deployments#list-deployments).", "type": "object", "properties": { "created_at": { "type": "string" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "environment": { "type": "string" }, "id": { "type": "integer" }, "node_id": { "type": "string" }, "original_environment": { "type": "string" }, "payload": { "oneOf": [{ "type": "string" }, { "type": "object" }], "type": ["null", "string", "object"] }, "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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-cloud@latest/rest/deployments/statuses#list-deployment-statuses).", "type": "object", "properties": { "created_at": { "type": "string" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" }, "workflow_run": { "title": "Deployment Workflow Run", "type": ["object", "null"], "properties": { "actor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null, "startup_failure" ] }, "created_at": { "type": "string", "format": "date-time" }, "display_title": { "type": "string" }, "event": { "type": "string" }, "head_branch": { "type": "string" }, "head_commit": { "type": ["null"] }, "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": ["null"] }, "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": ["null"] }, "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", "null"], "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": ["null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "answer": { "$ref": "#/components/schemas/webhooks_answer" }, "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" } }, "required": ["action", "discussion", "answer", "repository", "sender"] }, "webhooks_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": { "type": ["null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "title": "Discussion", "description": "A Discussion in a repository.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"] }, "answer_chosen_at": { "type": ["string", "null"] }, "answer_chosen_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "answer_html_url": { "type": ["string", "null"] }, "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" }, "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", "description": "The current state of the discussion.\n`converting` means that the discussion is being converted from an issue.\n`transferring` means that the discussion is being transferred from another repository.", "enum": ["open", "closed", "locked", "converting", "transferring"] }, "state_reason": { "description": "The reason for the current state", "type": ["string", "null"], "enum": ["resolved", "outdated", "duplicate", "reopened", null], "examples": ["resolved"] }, "timeline_url": { "type": "string" }, "title": { "type": "string" }, "updated_at": { "type": "string", "format": "date-time" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "labels": { "type": "array", "items": { "$ref": "#/components/schemas/label" } } }, "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", "active_lock_reason", "body" ] }, "label": { "title": "Label", "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", "type": "object", "properties": { "id": { "description": "Unique identifier for the label.", "type": "integer", "format": "int64", "examples": [208045946] }, "node_id": { "type": "string", "examples": ["MDU6TGFiZWwyMDgwNDU5NDY="] }, "url": { "description": "URL for the label", "type": "string", "format": "uri", "examples": ["https://api.github.com/repositories/42/labels/bug"] }, "name": { "description": "The name of the label.", "type": "string", "examples": ["bug"] }, "description": { "description": "Optional description of the label, such as its purpose.", "type": ["string", "null"], "examples": ["Something isn't working"] }, "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string", "examples": ["FFFFFF"] }, "default": { "description": "Whether this label comes by default in a new repository.", "type": "boolean", "examples": [true] }, "archived_at": { "description": "Timestamp indicating when the label was archived, or `null` if it has not been archived.", "type": ["string", "null"], "format": "date-time", "examples": ["2023-01-01T12:00:00Z"] }, "archived_by": { "description": "The user who archived the label, or `null` if it has not been archived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] } }, "required": [ "id", "node_id", "url", "name", "description", "color", "default", "archived_at", "archived_by" ] }, "webhook-discussion-category-changed": { "title": "discussion category changed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "changes", "discussion", "repository", "sender"] }, "webhook-discussion-closed": { "title": "discussion closed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-comment-created": { "title": "discussion_comment created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "comment": { "$ref": "#/components/schemas/webhooks_comment" }, "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" } }, "required": ["action", "comment", "discussion", "repository", "sender"] }, "webhooks_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", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhook-discussion-comment-deleted": { "title": "discussion_comment deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "comment": { "$ref": "#/components/schemas/webhooks_comment" }, "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" } }, "required": ["action", "comment", "discussion", "repository", "sender"] }, "webhook-discussion-comment-edited": { "title": "discussion_comment edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "type": "object", "properties": { "body": { "type": "object", "properties": { "from": { "type": "string" } }, "required": ["from"] } }, "required": ["body"] }, "comment": { "$ref": "#/components/schemas/webhooks_comment" }, "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" } }, "required": [ "action", "changes", "comment", "discussion", "repository", "sender" ] }, "webhook-discussion-created": { "title": "discussion created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-deleted": { "title": "discussion deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-edited": { "title": "discussion edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-labeled": { "title": "discussion labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["labeled"] }, "discussion": { "$ref": "#/components/schemas/discussion" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "discussion", "label", "repository", "sender"] }, "webhooks_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", "null"] }, "archived_at": { "description": "Timestamp indicating when the label was archived, or `null` if it has not been archived.", "type": ["string", "null"], "format": "date-time" }, "archived_by": { "description": "The user who archived the label, or `null` if it has not been archived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] }, "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", "archived_at", "archived_by" ] }, "webhook-discussion-locked": { "title": "discussion locked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-pinned": { "title": "discussion pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-reopened": { "title": "discussion reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-transferred": { "title": "discussion transferred event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "changes", "discussion", "repository", "sender"] }, "webhook-discussion-unanswered": { "title": "discussion unanswered event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unanswered"] }, "discussion": { "$ref": "#/components/schemas/discussion" }, "old_answer": { "$ref": "#/components/schemas/webhooks_answer" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "discussion", "old_answer", "repository"] }, "webhook-discussion-unlabeled": { "title": "discussion unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unlabeled"] }, "discussion": { "$ref": "#/components/schemas/discussion" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "discussion", "label", "repository", "sender"] }, "webhook-discussion-unlocked": { "title": "discussion unlocked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "webhook-discussion-unpinned": { "title": "discussion unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "discussion", "repository", "sender"] }, "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-cloud@latest/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" } ] }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"] }, "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", "null"] }, "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": { "type": ["null"] }, "languages_url": { "type": "string" }, "license": { "type": ["object", "null"] }, "merges_url": { "type": "string" }, "milestones_url": { "type": "string" }, "mirror_url": { "type": ["null"] }, "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": { "type": ["null"] } }, "trees_url": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" }, "visibility": { "type": "string" }, "watchers": { "type": "integer" }, "watchers_count": { "type": "integer" } } } ] }, "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" } }, "required": ["forkee", "repository", "sender"] }, "webhook-github-app-authorization-revoked": { "title": "github_app_authorization revoked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["revoked"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"] }, "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" } }, "required": ["pages", "repository", "sender"] }, "webhook-installation-created": { "title": "installation created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories": { "$ref": "#/components/schemas/webhooks_repositories" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "requester": { "$ref": "#/components/schemas/webhooks_user" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "installation", "sender"] }, "installation": { "title": "Installation", "description": "Installation", "type": "object", "properties": { "id": { "description": "The ID of the installation.", "type": "integer", "examples": [1] }, "account": { "anyOf": [ { "$ref": "#/components/schemas/simple-user" }, { "$ref": "#/components/schemas/enterprise" } ], "type": ["null", "object"] }, "repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved. For enterprise installations this is `selected`.", "type": "string", "enum": ["all", "selected"] }, "access_tokens_url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/app/installations/1/access_tokens" ] }, "repositories_url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/installation/repositories"] }, "html_url": { "type": "string", "format": "uri", "examples": [ "https://github.com/organizations/github/settings/installations/1" ] }, "app_id": { "type": "integer", "examples": [1] }, "client_id": { "type": "string", "examples": ["Iv1.ab1112223334445c"] }, "target_id": { "description": "The ID of the user or organization this token is being scoped to.", "type": "integer" }, "target_type": { "type": "string", "examples": ["Organization"] }, "permissions": { "$ref": "#/components/schemas/app-permissions" }, "events": { "type": "array", "items": { "type": "string" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "single_file_name": { "type": ["string", "null"], "examples": ["config.yaml"] }, "has_multiple_single_files": { "type": "boolean", "examples": [true] }, "single_file_paths": { "type": "array", "items": { "type": "string" }, "examples": ["config.yml", ".github/issue_TEMPLATE.md"] }, "app_slug": { "type": "string", "examples": ["github-actions"] }, "suspended_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "suspended_at": { "type": ["string", "null"], "format": "date-time" }, "contact_email": { "type": ["string", "null"], "examples": ["\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\""] } }, "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" ] }, "app-permissions": { "title": "App Permissions", "type": "object", "description": "The permissions granted to the fine-grained 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"] }, "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"] }, "artifact_metadata": { "type": "string", "description": "The level of permission to grant the access token to create and retrieve build artifact metadata records.", "enum": ["read", "write"] }, "attestations": { "type": "string", "description": "The level of permission to create and retrieve the access token for repository attestations.", "enum": ["read", "write"] }, "checks": { "type": "string", "description": "The level of permission to grant the access token for checks on code.", "enum": ["read", "write"] }, "code_quality": { "type": "string", "description": "The level of permission to grant the access token to view and manage code quality data.", "enum": ["read", "write"] }, "codespaces": { "type": "string", "description": "The level of permission to grant the access token to create, edit, delete, and list Codespaces.", "enum": ["read", "write"] }, "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"] }, "dependabot_secrets": { "type": "string", "description": "The level of permission to grant the access token to manage Dependabot secrets.", "enum": ["read", "write"] }, "deployments": { "type": "string", "description": "The level of permission to grant the access token for deployments and deployment statuses.", "enum": ["read", "write"] }, "discussions": { "type": "string", "description": "The level of permission to grant the access token for discussions and related comments and labels.", "enum": ["read", "write"] }, "environments": { "type": "string", "description": "The level of permission to grant the access token for managing repository environments.", "enum": ["read", "write"] }, "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"] }, "merge_queues": { "type": "string", "description": "The level of permission to grant the access token to manage the merge queues for a repository.", "enum": ["read", "write"] }, "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"] }, "packages": { "type": "string", "description": "The level of permission to grant the access token for packages published to GitHub Packages.", "enum": ["read", "write"] }, "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"] }, "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"] }, "repository_custom_properties": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for a repository, when allowed by the property.", "enum": ["read", "write"] }, "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"] }, "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"] }, "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"] }, "secrets": { "type": "string", "description": "The level of permission to grant the access token to manage repository secrets.", "enum": ["read", "write"] }, "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"] }, "single_file": { "type": "string", "description": "The level of permission to grant the access token to manage just a single file.", "enum": ["read", "write"] }, "statuses": { "type": "string", "description": "The level of permission to grant the access token for commit statuses.", "enum": ["read", "write"] }, "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"] }, "custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token to view and edit custom properties for an organization, when allowed by the property.", "enum": ["read", "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_custom_org_roles": { "type": "string", "description": "The level of permission to grant the access token for custom organization roles management.", "enum": ["read", "write"] }, "organization_custom_properties": { "type": "string", "description": "The level of permission to grant the access token for repository custom properties management at the organization level.", "enum": ["read", "write", "admin"] }, "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 public preview and is subject to change.", "enum": ["read", "write"] }, "organization_copilot_agent_settings": { "type": "string", "description": "The level of permission to grant the access token to view and manage Copilot cloud agent settings for an organization.", "enum": ["read", "write"] }, "organization_external_properties_for_repos": { "type": "string", "description": "The level of permission to grant the access token for managing external custom properties for repositories in an organization.", "enum": ["read", "write", "admin"] }, "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 public preview (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"] }, "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"] }, "enterprise_administration": { "type": "string", "description": "The level of permission to grant the access token to administer an enterprise account.", "enum": ["read", "write"] }, "enterprise_custom_properties_for_organizations": { "type": "string", "description": "The level of permission to grant the access token for organization custom properties management at the enterprise level.", "enum": ["read", "write", "admin"] }, "enterprise_organization_installations": { "type": "string", "description": "The level of permission to grant the access token to manage installation of GitHub Apps on Enterprise-owned organizations.", "enum": ["read", "write"] }, "enterprise_organization_installation_repositories": { "type": "string", "description": "The level of permission to grant the access token to manage repository access of GitHub Apps on Enterprise-owned organizations.", "enum": ["read", "write"] } }, "example": { "contents": "read", "issues": "read", "deployments": "write", "single_file": "read" } }, "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"] } }, "webhook-installation-deleted": { "title": "installation deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories": { "$ref": "#/components/schemas/webhooks_repositories" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "requester": { "type": ["null"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories": { "$ref": "#/components/schemas/webhooks_repositories" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "requester": { "type": ["null"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "installation", "sender"] }, "webhook-installation-repositories-added": { "title": "installation_repositories added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["added"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories_added": { "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "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": { "$ref": "#/components/schemas/webhooks_repository_selection" }, "requester": { "$ref": "#/components/schemas/webhooks_user" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "installation", "repository_selection", "repositories_added", "repositories_removed", "requester", "sender" ] }, "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"] } }, "webhooks_repository_selection": { "description": "Describe whether all repositories have been selected or there's a selection involved", "type": "string", "enum": ["all", "selected"] }, "webhook-installation-repositories-removed": { "title": "installation_repositories removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["removed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories_added": { "$ref": "#/components/schemas/webhooks_repositories_added" }, "repositories_removed": { "description": "An array of repository objects, which were removed from the installation. When `repository_selection` changes from `all` to `selected`, this array is empty.", "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": { "$ref": "#/components/schemas/webhooks_repository_selection" }, "requester": { "$ref": "#/components/schemas/webhooks_user" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories": { "$ref": "#/components/schemas/webhooks_repositories" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "requester": { "type": ["null"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "installation", "sender"] }, "webhook-installation-target-renamed": { "type": "object", "properties": { "account": { "type": "object", "properties": { "archived_at": { "type": ["string", "null"] }, "avatar_url": { "type": "string" }, "created_at": { "type": "string" }, "description": { "type": ["null"] }, "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": { "type": ["null"] }, "user_view_type": { "type": "string" } }, "required": ["id", "node_id", "avatar_url", "html_url"] }, "action": { "type": "string", "enum": ["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" }, "target_type": { "type": "string" } }, "required": [ "action", "target_type", "account", "changes", "installation" ] }, "webhook-installation-unsuspend": { "title": "installation unsuspend event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unsuspend"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repositories": { "$ref": "#/components/schemas/webhooks_repositories" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "requester": { "type": ["null"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "installation", "sender"] }, "webhook-issue-comment-created": { "title": "issue_comment created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/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": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/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" }, "pin": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/pinned-issue-comment" } ] }, "minimized": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment-minimized" } ] }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "type": ["object", "null"] } }, "author_association": { "type": "string" }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "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", "null"] }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "performed_via_github_app": { "type": ["object", "null"] }, "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", "format": "int64" }, "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"] } ] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "comment", "repository", "sender"] }, "pinned-issue-comment": { "title": "Pinned Issue Comment", "description": "Context around who pinned an issue comment and when it was pinned.", "type": "object", "properties": { "pinned_at": { "type": "string", "format": "date-time", "examples": ["2011-04-14T16:00:49Z"] }, "pinned_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] } }, "required": ["pinned_at", "pinned_by"] }, "issue-comment-minimized": { "title": "Minimized Issue Comment", "description": "Details about why an issue comment was minimized.", "type": "object", "properties": { "reason": { "description": "The reason the comment was minimized.", "type": ["string", "null"], "examples": ["low-quality"] } }, "required": ["reason"] }, "sub-issues-summary": { "title": "Sub-issues Summary", "type": "object", "properties": { "total": { "type": "integer" }, "completed": { "type": "integer" }, "percent_completed": { "type": "integer" } }, "required": ["total", "completed", "percent_completed"] }, "issue-dependencies-summary": { "title": "Issue Dependencies Summary", "type": "object", "properties": { "blocked_by": { "type": "integer" }, "blocking": { "type": "integer" }, "total_blocked_by": { "type": "integer" }, "total_blocking": { "type": "integer" } }, "required": [ "blocked_by", "blocking", "total_blocked_by", "total_blocking" ] }, "issue-type": { "title": "Issue Type", "description": "The type assigned to the issue. This is only present for issues in repositories where issue types are supported.", "type": ["object", "null"], "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue type." }, "node_id": { "type": "string", "description": "The node identifier of the issue type." }, "name": { "type": "string", "description": "The name of the issue type." }, "description": { "type": ["string", "null"], "description": "The description of the issue type." }, "color": { "type": ["string", "null"], "description": "The color of the issue type.", "enum": [ "gray", "blue", "green", "yellow", "orange", "red", "pink", "purple", null ] }, "created_at": { "type": "string", "description": "The time the issue type created.", "format": "date-time" }, "updated_at": { "type": "string", "description": "The time the issue type last updated.", "format": "date-time" }, "is_enabled": { "type": "boolean", "description": "The enabled state of the issue type." } }, "required": ["id", "node_id", "name", "description"] }, "webhook-issue-comment-deleted": { "title": "issue_comment deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "comment": { "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "type": ["object", "null"] } }, "author_association": { "type": "string" }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "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", "null"] }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "performed_via_github_app": { "type": ["object", "null"] }, "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", "format": "int64" }, "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" }, "user_view_type": { "type": "string" } } } }, "required": ["labels", "state", "locked", "assignee"] } ] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "comment", "repository", "sender"] }, "webhooks_issue_comment": { "title": "issue comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/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/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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "pin": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/pinned-issue-comment" } ] }, "minimized": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment-minimized" } ] } }, "required": [ "url", "html_url", "issue_url", "id", "node_id", "user", "created_at", "updated_at", "author_association", "performed_via_github_app", "body", "reactions" ] }, "webhook-issue-comment-edited": { "title": "issue_comment edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "$ref": "#/components/schemas/webhooks_changes" }, "comment": { "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "type": ["object", "null"] } }, "author_association": { "type": "string" }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "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", "null"] }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "performed_via_github_app": { "type": ["object", "null"] }, "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", "format": "int64" }, "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"] } ] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "changes", "issue", "comment", "repository", "sender" ] }, "webhooks_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"] } } }, "webhook-issue-comment-pinned": { "title": "issue_comment pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["pinned"] }, "comment": { "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "type": ["object", "null"] } }, "author_association": { "type": "string" }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "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", "null"] }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "performed_via_github_app": { "type": ["object", "null"] }, "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", "format": "int64" }, "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" }, "user_view_type": { "type": "string" } } } }, "required": ["labels", "state", "locked", "assignee"] } ] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "comment", "repository", "sender"] }, "webhook-issue-comment-unpinned": { "title": "issue_comment unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unpinned"] }, "comment": { "$ref": "#/components/schemas/webhooks_issue_comment" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) the comment belongs to.", "allOf": [ { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "type": ["object", "null"] } }, "author_association": { "type": "string" }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "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", "null"] }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "performed_via_github_app": { "type": ["object", "null"] }, "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", "format": "int64" }, "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" }, "user_view_type": { "type": "string" } } } }, "required": ["labels", "state", "locked", "assignee"] } ] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "comment", "repository", "sender"] }, "webhook-issue-dependencies-blocked-by-added": { "title": "blocked by issue added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["blocked_by_added"] }, "blocked_issue_id": { "description": "The ID of the blocked issue.", "type": "number" }, "blocked_issue": { "$ref": "#/components/schemas/issue" }, "blocking_issue_id": { "description": "The ID of the blocking issue.", "type": "number" }, "blocking_issue": { "$ref": "#/components/schemas/issue" }, "blocking_issue_repo": { "$ref": "#/components/schemas/repository" }, "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" } }, "required": ["action", "organization", "repository", "sender"] }, "issue": { "title": "Issue", "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri", "examples": ["https://api.github.com/repositories/42/issues/1"] }, "repository_url": { "type": "string", "format": "uri" }, "labels_url": { "type": "string" }, "comments_url": { "type": "string", "format": "uri" }, "events_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "number": { "description": "Number uniquely identifying the issue within its repository", "type": "integer", "examples": [42] }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "examples": ["open"] }, "state_reason": { "description": "The reason for the current state", "type": ["string", "null"], "enum": ["completed", "reopened", "not_planned", "duplicate", null], "examples": ["not_planned"] }, "title": { "description": "Title of the issue", "type": "string", "examples": ["Widget creation fails in Safari on OS X 10.8"] }, "body": { "description": "Contents of the issue", "type": ["string", "null"], "examples": [ "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?" ] }, "user": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "labels": { "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", "type": "array", "items": { "oneOf": [ { "type": "string" }, { "type": "object", "properties": { "id": { "type": "integer", "format": "int64" }, "node_id": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "name": { "type": "string" }, "description": { "type": ["string", "null"] }, "color": { "type": ["string", "null"] }, "default": { "type": "boolean" }, "archived_by": { "description": "The user who archived the label, or `null` if it has not been archived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] } } } ] }, "examples": ["bug", "registration"] }, "assignee": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "assignees": { "type": "array", "items": { "$ref": "#/components/schemas/simple-user" } }, "milestone": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/milestone" } ] }, "locked": { "type": "boolean" }, "active_lock_reason": { "type": ["string", "null"] }, "comments": { "type": "integer" }, "pull_request": { "type": "object", "properties": { "merged_at": { "type": ["string", "null"], "format": "date-time" }, "diff_url": { "type": ["string", "null"], "format": "uri" }, "html_url": { "type": ["string", "null"], "format": "uri" }, "patch_url": { "type": ["string", "null"], "format": "uri" }, "url": { "type": ["string", "null"], "format": "uri" } }, "required": ["diff_url", "html_url", "patch_url", "url"] }, "closed_at": { "type": ["string", "null"], "format": "date-time" }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" }, "draft": { "type": "boolean" }, "closed_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "body_html": { "type": "string" }, "body_text": { "type": "string" }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/issue-type" }, "repository": { "$ref": "#/components/schemas/repository" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/integration" } ] }, "author_association": { "$ref": "#/components/schemas/author-association" }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "parent_issue_url": { "description": "URL to get the parent issue of this issue, if it is a sub-issue", "type": ["string", "null"], "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } } }, "required": [ "assignee", "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ], "x-github-breaking-changes": [ { "changeset": "deprecate_beta_media_type", "patch": { "properties": { "pull_request": { "type": "object", "properties": { "merged_at": { "nullable": false }, "diff_url": { "nullable": false }, "html_url": { "nullable": false }, "patch_url": { "nullable": false }, "url": { "nullable": false } } } } }, "version": "2026-03-10" }, { "changeset": "remove_singular_assignee_from_issues_and_pull_requests", "patch": { "properties": { "assignee": null }, "required": [ "closed_at", "comments", "comments_url", "events_url", "html_url", "id", "node_id", "labels", "labels_url", "milestone", "number", "repository_url", "state", "locked", "title", "url", "user", "created_at", "updated_at" ] }, "version": "2026-03-10" } ] }, "reaction-rollup": { "title": "Reaction Rollup", "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "total_count": { "type": "integer" }, "+1": { "type": "integer" }, "-1": { "type": "integer" }, "laugh": { "type": "integer" }, "confused": { "type": "integer" }, "heart": { "type": "integer" }, "hooray": { "type": "integer" }, "eyes": { "type": "integer" }, "rocket": { "type": "integer" } }, "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ] }, "issue-comment": { "title": "Issue Comment", "description": "Comments provide a way for people to collaborate on an issue.", "type": "object", "properties": { "id": { "description": "Unique identifier of the issue comment", "type": "integer", "format": "int64", "examples": [42] }, "node_id": { "type": "string" }, "url": { "description": "URL for the issue comment", "type": "string", "format": "uri", "examples": [ "https://api.github.com/repositories/42/issues/comments/1" ] }, "body": { "description": "Contents of the issue comment", "type": "string", "examples": [ "What version of Safari were you using when you observed this bug?" ] }, "body_text": { "type": "string" }, "body_html": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "user": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2011-04-14T16:00:49Z"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["2011-04-14T16:00:49Z"] }, "issue_url": { "type": "string", "format": "uri" }, "author_association": { "$ref": "#/components/schemas/author-association" }, "performed_via_github_app": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/integration" } ] }, "reactions": { "$ref": "#/components/schemas/reaction-rollup" }, "pin": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/pinned-issue-comment" } ] }, "minimized": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment-minimized" } ] } }, "required": [ "id", "node_id", "html_url", "issue_url", "user", "url", "created_at", "updated_at" ] }, "issue-field-value": { "title": "Issue Field Value", "description": "A value assigned to an issue field", "type": "object", "properties": { "issue_field_id": { "description": "Unique identifier for the issue field.", "type": "integer", "format": "int64", "examples": [1] }, "issue_field_name": { "description": "The human-readable name of the issue field.", "type": "string", "examples": ["Priority"] }, "node_id": { "type": "string", "examples": ["IFT_GDKND"] }, "data_type": { "description": "The data type of the issue field", "type": "string", "enum": ["text", "single_select", "multi_select", "number", "date"], "examples": ["text"] }, "value": { "description": "The value of the issue field", "anyOf": [ { "type": "string", "examples": ["Sample text"] }, { "type": "number", "examples": [42.5] }, { "type": "integer", "examples": [1] } ], "type": ["null", "string", "number", "integer"] }, "single_select_option": { "description": "Details about the selected option (only present for single_select fields)", "type": ["object", "null"], "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [1] }, "name": { "description": "The name of the option", "type": "string", "examples": ["High"] }, "color": { "description": "The color of the option", "type": "string", "examples": ["red"] } }, "required": ["id", "name", "color"] }, "multi_select_options": { "description": "Details about the selected options", "type": ["array", "null"], "items": { "type": "object", "properties": { "id": { "description": "Unique identifier for the option.", "type": "integer", "format": "int64", "examples": [1] }, "name": { "description": "The name of the option", "type": "string", "examples": ["High"] }, "color": { "description": "The color of the option", "type": "string", "examples": ["red"] } }, "required": ["id", "name", "color"] } } }, "required": ["issue_field_id", "node_id", "data_type", "value"] }, "webhook-issue-dependencies-blocked-by-removed": { "title": "blocked by issue removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["blocked_by_removed"] }, "blocked_issue_id": { "description": "The ID of the blocked issue.", "type": "number" }, "blocked_issue": { "$ref": "#/components/schemas/issue" }, "blocking_issue_id": { "description": "The ID of the blocking issue.", "type": "number" }, "blocking_issue": { "$ref": "#/components/schemas/issue" }, "blocking_issue_repo": { "$ref": "#/components/schemas/repository" }, "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" } }, "required": ["action", "organization", "repository", "sender"] }, "webhook-issue-dependencies-blocking-added": { "title": "blocking issue added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["blocking_added"] }, "blocked_issue_id": { "description": "The ID of the blocked issue.", "type": "number" }, "blocked_issue": { "$ref": "#/components/schemas/issue" }, "blocked_issue_repo": { "$ref": "#/components/schemas/repository" }, "blocking_issue_id": { "description": "The ID of the blocking issue.", "type": "number" }, "blocking_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": ["action", "organization", "repository", "sender"] }, "webhook-issue-dependencies-blocking-removed": { "title": "blocking issue removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["blocking_removed"] }, "blocked_issue_id": { "description": "The ID of the blocked issue.", "type": "number" }, "blocked_issue": { "$ref": "#/components/schemas/issue" }, "blocked_issue_repo": { "$ref": "#/components/schemas/repository" }, "blocking_issue_id": { "description": "The ID of the blocking issue.", "type": "number" }, "blocking_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": ["action", "organization", "repository", "sender"] }, "webhook-issue-relates-to-added": { "title": "relates to issue added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["relates_to_added"] }, "issue_id": { "description": "The ID of the issue the relationship was added to.", "type": "number" }, "issue": { "$ref": "#/components/schemas/issue" }, "related_issue_id": { "description": "The ID of the related issue. Only present when both issues belong to the same repository.", "type": "number" }, "related_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": ["action", "organization", "repository", "sender"] }, "webhook-issue-relates-to-removed": { "title": "relates to issue removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["relates_to_removed"] }, "issue_id": { "description": "The ID of the issue the relationship was removed from.", "type": "number" }, "issue": { "$ref": "#/components/schemas/issue" }, "related_issue_id": { "description": "The ID of the related issue. Only present when both issues belong to the same repository.", "type": "number" }, "related_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": ["action", "organization", "repository", "sender"] }, "webhook-issues-assigned": { "title": "issues assigned event", "type": "object", "properties": { "action": { "description": "The action that was performed.", "type": "string", "enum": ["assigned"] }, "assignee": { "$ref": "#/components/schemas/webhooks_user" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhooks_issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhook-issues-closed": { "title": "issues closed event", "type": "object", "properties": { "action": { "description": "The action that was performed.", "type": "string", "enum": ["closed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "allOf": [ { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "assignee": { "type": ["object", "null"] }, "assignees": { "type": "array", "items": { "type": ["object", "null"] } }, "author_association": { "type": "string" }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] } }, "labels_url": { "type": "string" }, "locked": { "type": "boolean" }, "milestone": { "type": ["object", "null"] }, "node_id": { "type": "string" }, "number": { "type": "integer" }, "performed_via_github_app": { "type": ["object", "null"] }, "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", "format": "int64" }, "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" }, "user_view_type": { "type": "string" } } } }, "required": ["state", "closed_at"] } ] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-deleted": { "title": "issues deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-demilestoned": { "title": "issues demilestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["demilestoned"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", "assignees", "author_association", "body", "closed_at", "comments", "comments_url", "created_at", "events_url", "html_url", "id", "labels_url", "milestone", "node_id", "number", "reactions", "repository_url", "title", "updated_at", "url", "user" ], "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" } } }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" } } } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"], "required": [ "id", "node_id", "url", "name", "color", "default", "description" ], "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string" }, "default": { "type": "boolean" }, "description": { "type": ["string", "null"] }, "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" } } } }, "labels_url": { "type": "string", "format": "uri-template" }, "locked": { "type": "boolean" }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "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" ], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } } }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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" } } }, "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", "null"], "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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"] }, "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", "null"], "format": "date-time" } } }, "pull_request": { "type": "object", "properties": { "diff_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "patch_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" } } }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "repository_url": { "type": "string", "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } } } } }, "milestone": { "$ref": "#/components/schemas/webhooks_milestone" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhooks_milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": "object", "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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" ] }, "webhook-issues-edited": { "title": "issues edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/issue-type" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "issue", "repository", "sender"] }, "webhook-issues-field-added": { "title": "issues field_added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["field_added"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "issue_field": { "type": "object", "description": "The issue field whose value was set or updated on the issue.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue field." }, "name": { "type": "string", "description": "The name of the issue field." }, "field_type": { "type": "string", "description": "The data type of the issue field.", "enum": [ "text", "date", "single_select", "multi_select", "number" ] } }, "required": ["id", "name", "field_type"] }, "issue_field_value": { "type": "object", "description": "The value that was set or updated for the issue field. When updating an existing value, the previous value is available in `changes`.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue field value." }, "value": { "description": "The value of the field. Present for text, date, and number field types.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" } ], "type": ["null", "string", "number", "integer"] }, "value_id": { "type": "integer", "description": "The identifier of the selected option. Present for single_select field types." }, "option": { "type": "object", "description": "The selected option details. Present for single_select field types.", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": ["string", "null"] } } }, "value_ids": { "type": "array", "items": { "type": "integer" }, "description": "The identifiers of the selected options. Present for multi_select field types." }, "options": { "type": "array", "description": "The selected option details. Present for multi_select field types.", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": ["string", "null"] } } } } }, "required": ["id"] }, "changes": { "type": "object", "description": "The previous field value, present when an existing value was updated.", "properties": { "issue_field_value": { "type": "object", "description": "The previous issue field value data.", "properties": { "from": { "type": "object", "description": "The previous value of the issue field before the update.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue field value." }, "value": { "description": "The previous value. Present for text, date, and number field types.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" } ], "type": ["null", "string", "number", "integer"] }, "value_id": { "type": "integer", "description": "The identifier of the previously selected option. Present for single_select field types." }, "option": { "type": "object", "description": "The previously selected option details. Present for single_select field types.", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": ["string", "null"] } } }, "value_ids": { "type": "array", "items": { "type": "integer" }, "description": "The identifiers of the previously selected options. Present for multi_select field types." }, "options": { "type": "array", "description": "The previously selected option details. Present for multi_select field types.", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": ["string", "null"] } } } } }, "required": ["id"] } }, "required": ["from"] } } }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "issue_field", "repository", "sender"] }, "webhook-issues-field-removed": { "title": "issues field_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["field_removed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "issue_field": { "type": "object", "description": "The issue field whose value was cleared from the issue.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue field." }, "name": { "type": "string", "description": "The name of the issue field." }, "field_type": { "type": "string", "description": "The data type of the issue field.", "enum": [ "text", "date", "single_select", "multi_select", "number" ] } }, "required": ["id", "name", "field_type"] }, "issue_field_value": { "type": "object", "description": "The value that was cleared from the issue field.", "properties": { "id": { "type": "integer", "description": "The unique identifier of the issue field value." }, "value": { "description": "The value of the field. Present for text, date, and number field types.", "anyOf": [ { "type": "string" }, { "type": "number" }, { "type": "integer" } ], "type": ["null", "string", "number", "integer"] }, "value_id": { "type": "integer", "description": "The identifier of the selected option. Present for single_select field types." }, "option": { "type": "object", "description": "The selected option details. Present for single_select field types.", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": ["string", "null"] } } }, "value_ids": { "type": "array", "items": { "type": "integer" }, "description": "The identifiers of the selected options. Present for multi_select field types." }, "options": { "type": "array", "description": "The selected option details. Present for multi_select field types.", "items": { "type": "object", "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "color": { "type": "string" }, "description": { "type": ["string", "null"] } } } } }, "required": ["id"] }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "issue_field", "repository", "sender"] }, "webhook-issues-labeled": { "title": "issues labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["labeled"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "archived_at": { "description": "Timestamp indicating when the label was archived, or `null` if it has not been archived.", "type": ["string", "null"], "format": "date-time" }, "archived_by": { "description": "The user who archived the label, or `null` if it has not been archived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] }, "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", "archived_at", "archived_by" ] } }, "labels_url": { "type": "string", "format": "uri-template" }, "locked": { "type": "boolean" }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/issue-type" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-locked": { "title": "issues locked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["locked"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", "assignees", "author_association", "body", "closed_at", "comments", "comments_url", "created_at", "events_url", "html_url", "id", "labels_url", "locked", "milestone", "node_id", "number", "reactions", "repository_url", "title", "updated_at", "url", "user" ], "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"], "required": [ "id", "node_id", "url", "name", "color", "default", "description" ], "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string" }, "default": { "type": "boolean" }, "description": { "type": ["string", "null"] }, "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" } } } }, "labels_url": { "type": "string", "format": "uri-template" }, "locked": { "type": "boolean", "enum": [true] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "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" ], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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" } } }, "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", "null"], "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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"] }, "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", "null"], "format": "date-time" } } }, "pull_request": { "type": "object", "properties": { "diff_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "patch_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" } } }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "repository_url": { "type": "string", "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "type": { "$ref": "#/components/schemas/issue-type" }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } } } }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-milestoned": { "title": "issues milestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["milestoned"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", "assignees", "author_association", "body", "closed_at", "comments", "comments_url", "created_at", "events_url", "html_url", "id", "labels_url", "milestone", "node_id", "number", "reactions", "repository_url", "title", "updated_at", "url", "user" ], "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"], "required": [ "id", "node_id", "url", "name", "color", "default", "description" ], "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string" }, "default": { "type": "boolean" }, "description": { "type": ["string", "null"] }, "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" } } } }, "labels_url": { "type": "string", "format": "uri-template" }, "locked": { "type": "boolean" }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "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" ], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } } }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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" } } }, "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", "null"], "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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"] }, "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", "null"], "format": "date-time" } } }, "pull_request": { "type": "object", "properties": { "diff_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "patch_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" } } }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "repository_url": { "type": "string", "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } } } }, "milestone": { "$ref": "#/components/schemas/webhooks_milestone" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "milestone", "repository", "sender"] }, "webhook-issues-opened": { "title": "issues opened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["opened"] }, "changes": { "type": "object", "properties": { "old_issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": ["object", "null"], "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "type": { "$ref": "#/components/schemas/issue-type" } }, "required": ["id", "number"] }, "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" } ] }, "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", "null"] }, "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_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-pinned": { "title": "issues pinned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["pinned"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue_2" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhooks_issue_2": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhook-issues-reopened": { "title": "issues reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["reopened"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", "assignees", "author_association", "body", "closed_at", "comments", "comments_url", "created_at", "events_url", "html_url", "id", "labels_url", "milestone", "node_id", "number", "reactions", "repository_url", "state", "title", "updated_at", "url", "user" ], "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" } } } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"], "required": [ "id", "node_id", "url", "name", "color", "default", "description" ], "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string" }, "default": { "type": "boolean" }, "description": { "type": ["string", "null"] }, "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" } } } }, "labels_url": { "type": "string", "format": "uri-template" }, "locked": { "type": "boolean" }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "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" ], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } } }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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" } } }, "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", "null"], "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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"] }, "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", "null"], "format": "date-time" } } }, "pull_request": { "type": "object", "properties": { "diff_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "patch_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" } } }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "repository_url": { "type": "string", "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } } }, "type": { "$ref": "#/components/schemas/issue-type" } } }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-transferred": { "title": "issues transferred event", "type": "object", "properties": { "action": { "type": "string", "enum": ["transferred"] }, "changes": { "type": "object", "properties": { "new_issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "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", "null"], "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", "null"], "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" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" } ] }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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": { "$ref": "#/components/schemas/webhooks_issue_2" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "issue", "repository", "sender"] }, "webhook-issues-typed": { "title": "issues typed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["typed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "type": { "$ref": "#/components/schemas/issue-type" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "type", "repository", "sender"] }, "webhook-issues-unassigned": { "title": "issues unassigned event", "type": "object", "properties": { "action": { "description": "The action that was performed.", "type": "string", "enum": ["unassigned"] }, "assignee": { "$ref": "#/components/schemas/webhooks_user_mannequin" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhooks_user_mannequin": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "webhook-issues-unlabeled": { "title": "issues unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unlabeled"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-unlocked": { "title": "issues unlocked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unlocked"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "title": "Issue", "description": "The [issue](https://docs.github.com/enterprise-cloud@latest/rest/issues/issues#get-an-issue) itself.", "type": "object", "required": [ "active_lock_reason", "assignees", "author_association", "body", "closed_at", "comments", "comments_url", "created_at", "events_url", "html_url", "id", "labels_url", "locked", "milestone", "node_id", "number", "reactions", "repository_url", "title", "updated_at", "url", "user" ], "properties": { "active_lock_reason": { "type": ["string", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } } }, "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", "null"] }, "closed_at": { "type": ["string", "null"], "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", "null"], "required": [ "id", "node_id", "url", "name", "color", "default", "description" ], "properties": { "color": { "description": "6-character hex code, without the leading #, identifying the color", "type": "string" }, "default": { "type": "boolean" }, "description": { "type": ["string", "null"] }, "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" } } } }, "labels_url": { "type": "string", "format": "uri-template" }, "locked": { "type": "boolean", "enum": [false] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "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" ], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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" } } }, "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", "null"], "required": [ "id", "node_id", "owner", "name", "description", "external_url", "html_url", "created_at", "updated_at" ], "properties": { "created_at": { "type": ["string", "null"], "format": "date-time" }, "description": { "type": ["string", "null"] }, "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", "null"], "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the GitHub app", "type": ["integer", "null"] }, "name": { "description": "The name of the GitHub app", "type": "string" }, "node_id": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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"] }, "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", "null"], "format": "date-time" } } }, "pull_request": { "type": "object", "properties": { "diff_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "patch_url": { "type": "string", "format": "uri" }, "url": { "type": "string", "format": "uri" } } }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "repository_url": { "type": "string", "format": "uri" }, "pinned_comment": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/issue-comment" } ] }, "sub_issues_summary": { "$ref": "#/components/schemas/sub-issues-summary" }, "issue_dependencies_summary": { "$ref": "#/components/schemas/issue-dependencies-summary" }, "issue_field_values": { "type": "array", "items": { "$ref": "#/components/schemas/issue-field-value" } }, "state": { "description": "State of the issue; either 'open' or 'closed'", "type": "string", "enum": ["open", "closed"] }, "state_reason": { "type": ["string", "null"] }, "timeline_url": { "type": "string", "format": "uri" }, "title": { "description": "Title of the issue", "type": "string" }, "type": { "$ref": "#/components/schemas/issue-type" }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "description": "URL for the issue", "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } } } }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-unpinned": { "title": "issues unpinned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unpinned"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue_2" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "repository", "sender"] }, "webhook-issues-untyped": { "title": "issues untyped event", "type": "object", "properties": { "action": { "type": "string", "enum": ["untyped"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "issue": { "$ref": "#/components/schemas/webhooks_issue" }, "type": { "$ref": "#/components/schemas/issue-type" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "issue", "type", "repository", "sender"] }, "webhook-label-archived": { "title": "label archived event", "type": "object", "properties": { "action": { "type": "string", "enum": ["archived"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label_archived" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "label", "repository", "sender"] }, "webhooks_label_archived": { "title": "Archived label", "allOf": [ { "$ref": "#/components/schemas/webhooks_label" }, { "type": "object", "properties": { "archived_at": { "description": "Timestamp indicating when the label was archived.", "type": "string", "format": "date-time" }, "archived_by": { "description": "The user who archived the label.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }] } }, "required": ["archived_at", "archived_by"] } ] }, "webhook-label-created": { "title": "label created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "label", "repository"] }, "webhook-label-deleted": { "title": "label deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "label", "repository", "sender"] }, "webhook-label-edited": { "title": "label edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_label" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "label", "repository", "sender"] }, "webhook-label-unarchived": { "title": "label unarchived event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unarchived"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label_unarchived" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "label", "repository", "sender"] }, "webhooks_label_unarchived": { "title": "Unarchived label", "allOf": [ { "$ref": "#/components/schemas/webhooks_label" }, { "type": "object", "properties": { "archived_at": { "description": "Timestamp indicating when the label was archived. This is `null` after the label is unarchived.", "type": ["string", "null"], "format": "date-time" }, "archived_by": { "description": "The user who archived the label. This is `null` after the label is unarchived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] } }, "required": ["archived_at", "archived_by"] } ] }, "webhook-marketplace-purchase-cancelled": { "title": "marketplace_purchase cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["cancelled"] }, "effective_date": { "type": "string" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "marketplace_purchase": { "$ref": "#/components/schemas/webhooks_marketplace_purchase" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "previous_marketplace_purchase": { "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "effective_date", "sender", "marketplace_purchase" ] }, "webhooks_marketplace_purchase": { "title": "Marketplace Purchase", "type": "object", "required": [ "account", "billing_cycle", "free_trial_ends_on", "next_billing_date", "on_free_trial", "plan", "unit_count" ], "properties": { "account": { "type": "object", "required": [ "type", "id", "node_id", "login", "organization_billing_email" ], "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "node_id": { "type": "string" }, "organization_billing_email": { "type": ["string", "null"] }, "type": { "type": "string" } } }, "billing_cycle": { "type": "string" }, "free_trial_ends_on": { "type": ["string", "null"] }, "next_billing_date": { "type": ["string", "null"] }, "on_free_trial": { "type": "boolean" }, "plan": { "type": "object", "required": [ "id", "name", "description", "monthly_price_in_cents", "yearly_price_in_cents", "price_model", "has_free_trial", "unit_name", "bullets" ], "properties": { "bullets": { "type": "array", "items": { "type": ["string", "null"] } }, "description": { "type": "string" }, "has_free_trial": { "type": "boolean" }, "id": { "type": "integer" }, "monthly_price_in_cents": { "type": "integer" }, "name": { "type": "string" }, "price_model": { "type": "string", "enum": ["FREE", "FLAT_RATE", "PER_UNIT"] }, "unit_name": { "type": ["string", "null"] }, "yearly_price_in_cents": { "type": "integer" } } }, "unit_count": { "type": "integer" } } }, "webhooks_previous_marketplace_purchase": { "title": "Marketplace Purchase", "type": "object", "properties": { "account": { "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "node_id": { "type": "string" }, "organization_billing_email": { "type": ["string", "null"] }, "type": { "type": "string" } }, "required": [ "type", "id", "node_id", "login", "organization_billing_email" ] }, "billing_cycle": { "type": "string" }, "free_trial_ends_on": { "type": ["null"] }, "next_billing_date": { "type": ["string", "null"] }, "on_free_trial": { "type": "boolean" }, "plan": { "type": "object", "properties": { "bullets": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "has_free_trial": { "type": "boolean" }, "id": { "type": "integer" }, "monthly_price_in_cents": { "type": "integer" }, "name": { "type": "string" }, "price_model": { "type": "string", "enum": ["FREE", "FLAT_RATE", "PER_UNIT"] }, "unit_name": { "type": ["string", "null"] }, "yearly_price_in_cents": { "type": "integer" } }, "required": [ "id", "name", "description", "monthly_price_in_cents", "yearly_price_in_cents", "price_model", "has_free_trial", "unit_name", "bullets" ] }, "unit_count": { "type": "integer" } }, "required": [ "account", "billing_cycle", "unit_count", "on_free_trial", "free_trial_ends_on", "plan" ] }, "webhook-marketplace-purchase-changed": { "title": "marketplace_purchase changed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["changed"] }, "effective_date": { "type": "string" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "marketplace_purchase": { "$ref": "#/components/schemas/webhooks_marketplace_purchase" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "previous_marketplace_purchase": { "title": "Marketplace Purchase", "type": "object", "properties": { "account": { "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "node_id": { "type": "string" }, "organization_billing_email": { "type": ["string", "null"] }, "type": { "type": "string" } }, "required": [ "type", "id", "node_id", "login", "organization_billing_email" ] }, "billing_cycle": { "type": "string" }, "free_trial_ends_on": { "type": ["string", "null"] }, "next_billing_date": { "type": ["string", "null"] }, "on_free_trial": { "type": ["boolean", "null"] }, "plan": { "type": "object", "properties": { "bullets": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "has_free_trial": { "type": "boolean" }, "id": { "type": "integer" }, "monthly_price_in_cents": { "type": "integer" }, "name": { "type": "string" }, "price_model": { "type": "string", "enum": ["FREE", "FLAT_RATE", "PER_UNIT"] }, "unit_name": { "type": ["string", "null"] }, "yearly_price_in_cents": { "type": "integer" } }, "required": [ "id", "name", "description", "monthly_price_in_cents", "yearly_price_in_cents", "price_model", "has_free_trial", "unit_name", "bullets" ] }, "unit_count": { "type": "integer" } }, "required": [ "account", "billing_cycle", "unit_count", "on_free_trial", "free_trial_ends_on", "plan" ] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "effective_date", "sender", "marketplace_purchase" ] }, "webhook-marketplace-purchase-pending-change": { "title": "marketplace_purchase pending_change event", "type": "object", "properties": { "action": { "type": "string", "enum": ["pending_change"] }, "effective_date": { "type": "string" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "marketplace_purchase": { "$ref": "#/components/schemas/webhooks_marketplace_purchase" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "previous_marketplace_purchase": { "title": "Marketplace Purchase", "type": "object", "properties": { "account": { "type": "object", "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "node_id": { "type": "string" }, "organization_billing_email": { "type": ["string", "null"] }, "type": { "type": "string" } }, "required": [ "type", "id", "node_id", "login", "organization_billing_email" ] }, "billing_cycle": { "type": "string" }, "free_trial_ends_on": { "type": ["string", "null"] }, "next_billing_date": { "type": ["string", "null"] }, "on_free_trial": { "type": "boolean" }, "plan": { "type": "object", "properties": { "bullets": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "has_free_trial": { "type": "boolean" }, "id": { "type": "integer" }, "monthly_price_in_cents": { "type": "integer" }, "name": { "type": "string" }, "price_model": { "type": "string", "enum": ["FREE", "FLAT_RATE", "PER_UNIT"] }, "unit_name": { "type": ["string", "null"] }, "yearly_price_in_cents": { "type": "integer" } }, "required": [ "id", "name", "description", "monthly_price_in_cents", "yearly_price_in_cents", "price_model", "has_free_trial", "unit_name", "bullets" ] }, "unit_count": { "type": "integer" } }, "required": [ "account", "billing_cycle", "unit_count", "on_free_trial", "free_trial_ends_on", "plan" ] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "effective_date", "sender", "marketplace_purchase" ] }, "webhook-marketplace-purchase-pending-change-cancelled": { "title": "marketplace_purchase pending_change_cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["pending_change_cancelled"] }, "effective_date": { "type": "string" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "marketplace_purchase": { "title": "Marketplace Purchase", "type": "object", "required": [ "account", "billing_cycle", "free_trial_ends_on", "next_billing_date", "on_free_trial", "plan", "unit_count" ], "properties": { "account": { "type": "object", "required": [ "type", "id", "node_id", "login", "organization_billing_email" ], "properties": { "id": { "type": "integer" }, "login": { "type": "string" }, "node_id": { "type": "string" }, "organization_billing_email": { "type": ["string", "null"] }, "type": { "type": "string" } } }, "billing_cycle": { "type": "string" }, "free_trial_ends_on": { "type": ["null"] }, "next_billing_date": { "type": ["string", "null"] }, "on_free_trial": { "type": "boolean" }, "plan": { "type": "object", "required": [ "id", "name", "description", "monthly_price_in_cents", "yearly_price_in_cents", "price_model", "has_free_trial", "unit_name", "bullets" ], "properties": { "bullets": { "type": "array", "items": { "type": "string" } }, "description": { "type": "string" }, "has_free_trial": { "type": "boolean" }, "id": { "type": "integer" }, "monthly_price_in_cents": { "type": "integer" }, "name": { "type": "string" }, "price_model": { "type": "string", "enum": ["FREE", "FLAT_RATE", "PER_UNIT"] }, "unit_name": { "type": ["string", "null"] }, "yearly_price_in_cents": { "type": "integer" } } }, "unit_count": { "type": "integer" } } }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "previous_marketplace_purchase": { "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "effective_date", "sender", "marketplace_purchase" ] }, "webhook-marketplace-purchase-purchased": { "title": "marketplace_purchase purchased event", "type": "object", "properties": { "action": { "type": "string", "enum": ["purchased"] }, "effective_date": { "type": "string" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "marketplace_purchase": { "$ref": "#/components/schemas/webhooks_marketplace_purchase" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "previous_marketplace_purchase": { "$ref": "#/components/schemas/webhooks_previous_marketplace_purchase" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "effective_date", "sender", "marketplace_purchase" ] }, "webhook-member-added": { "title": "member added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["added"] }, "changes": { "type": "object", "properties": { "permission": { "description": "This field is included for legacy purposes; use the `role_name` field instead. The `maintain`\nrole is mapped to `write` and the `triage` role is mapped to `read`. To determine the role\nassigned to the collaborator, use the `role_name` field instead, which will provide the full\nrole 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": { "$ref": "#/components/schemas/webhooks_user" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "member", "repository", "sender"] }, "webhook-member-edited": { "title": "member edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "to": { "type": ["string", "null"] } } } } }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "member": { "$ref": "#/components/schemas/webhooks_user" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "member", "repository", "sender"] }, "webhook-member-removed": { "title": "member removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["removed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "member": { "$ref": "#/components/schemas/webhooks_user" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "member", "repository", "sender"] }, "webhook-membership-added": { "title": "membership added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["added"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "member": { "$ref": "#/components/schemas/webhooks_user" }, "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"] }, "sender": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "team": { "$ref": "#/components/schemas/webhooks_team" } }, "required": [ "action", "scope", "member", "sender", "team", "organization" ] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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"] }, "notification_setting": { "description": "Whether team members will receive notifications when their team is @mentioned", "type": "string", "enum": ["notifications_enabled", "notifications_disabled"] }, "repositories_url": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "url": { "description": "URL for the team", "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": ["enterprise", "organization"] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [37] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [42] } }, "required": [ "name", "id", "node_id", "slug", "description", "privacy", "notification_setting", "url", "html_url", "members_url", "repositories_url", "permission", "type" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string" }, "privacy": { "type": "string", "enum": ["open", "closed", "secret"] }, "notification_setting": { "type": "string", "enum": ["notifications_enabled", "notifications_disabled"] }, "repositories_url": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "url": { "description": "URL for the team", "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": ["enterprise", "organization"] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [37] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [42] } }, "required": ["name", "id"] }, "webhook-membership-removed": { "title": "membership removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["removed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "member": { "$ref": "#/components/schemas/webhooks_user" }, "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"] }, "sender": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "team": { "$ref": "#/components/schemas/webhooks_team" } }, "required": [ "action", "scope", "member", "sender", "team", "organization" ] }, "webhook-merge-group-checks-requested": { "type": "object", "properties": { "action": { "type": "string", "enum": ["checks_requested"] }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "merge_group": { "$ref": "#/components/schemas/merge-group" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "merge_group"] }, "merge-group": { "type": "object", "title": "Merge Group", "description": "A group of pull requests that the merge queue has grouped together to be merged.", "properties": { "head_sha": { "description": "The SHA of the merge group.", "type": "string" }, "head_ref": { "description": "The full ref of the merge group.", "type": "string" }, "base_sha": { "description": "The SHA of the merge group's parent commit.", "type": "string" }, "base_ref": { "description": "The full ref of the branch the merge group will be merged into.", "type": "string" }, "head_commit": { "$ref": "#/components/schemas/simple-commit" } }, "required": [ "head_sha", "head_ref", "base_sha", "base_ref", "head_commit" ] }, "simple-commit": { "title": "Simple Commit", "description": "A commit.", "type": "object", "properties": { "id": { "type": "string", "description": "SHA for the commit", "examples": ["7638417db6d59f3c431d3e1f261cc637155684cd"] }, "tree_id": { "type": "string", "description": "SHA for the commit's tree" }, "message": { "description": "Message describing the purpose of the commit", "type": "string", "examples": ["Fix #42"] }, "timestamp": { "description": "Timestamp of the commit", "format": "date-time", "type": "string", "examples": ["2014-08-09T08:02:04+12:00"] }, "author": { "type": ["object", "null"], "description": "Information about the Git author", "properties": { "name": { "description": "Name of the commit's author", "type": "string", "examples": ["Monalisa Octocat"] }, "email": { "description": "Git email address of the commit's author", "type": "string", "format": "email", "examples": ["monalisa.octocat@example.com"] } }, "required": ["name", "email"] }, "committer": { "type": ["object", "null"], "description": "Information about the Git committer", "properties": { "name": { "description": "Name of the commit's committer", "type": "string", "examples": ["Monalisa Octocat"] }, "email": { "description": "Git email address of the commit's committer", "type": "string", "format": "email", "examples": ["monalisa.octocat@example.com"] } }, "required": ["name", "email"] } }, "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ] }, "webhook-merge-group-destroyed": { "type": "object", "properties": { "action": { "type": "string", "enum": ["destroyed"] }, "reason": { "type": "string", "description": "Explains why the merge group is being destroyed. The group could have been merged, removed from the queue (dequeued), or invalidated by an earlier queue entry being dequeued (invalidated).", "enum": ["merged", "invalidated", "dequeued"] }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "merge_group": { "$ref": "#/components/schemas/merge-group" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "merge_group"] }, "webhook-meta-deleted": { "title": "meta deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "hook": { "description": "The deleted 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": { "description": "", "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" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/repository-webhooks" } ] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "hook_id", "hook"] }, "webhook-milestone-closed": { "title": "milestone closed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"] }, "due_on": { "type": ["string", "null"], "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": ["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" } }, "required": ["action", "milestone", "repository", "sender"] }, "webhook-milestone-created": { "title": "milestone created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": ["null"] }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"] }, "due_on": { "type": ["string", "null"], "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"] }, "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" } }, "required": ["action", "milestone", "repository", "sender"] }, "webhook-milestone-deleted": { "title": "milestone deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "milestone": { "$ref": "#/components/schemas/webhooks_milestone" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "milestone", "repository", "sender"] }, "webhook-milestone-edited": { "title": "milestone edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_milestone" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "milestone", "repository", "sender"] }, "webhook-milestone-opened": { "title": "milestone opened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": ["null"] }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"] }, "due_on": { "type": ["string", "null"], "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"] }, "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" } }, "required": ["action", "milestone", "repository", "sender"] }, "webhook-org-block-blocked": { "title": "org_block blocked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["blocked"] }, "blocked_user": { "$ref": "#/components/schemas/webhooks_user" }, "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" } }, "required": ["action", "blocked_user", "organization", "sender"] }, "webhook-org-block-unblocked": { "title": "org_block unblocked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unblocked"] }, "blocked_user": { "$ref": "#/components/schemas/webhooks_user" }, "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" } }, "required": ["action", "blocked_user", "organization", "sender"] }, "webhook-organization-custom-property-created": { "title": "organization custom property created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "definition": { "$ref": "#/components/schemas/organization-custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition", "enterprise"] }, "organization-custom-property": { "title": "Custom Property for Organization", "description": "Custom property defined for an organization", "allOf": [ { "$ref": "#/components/schemas/custom-property-base" }, { "type": "object", "properties": { "values_editable_by": { "type": ["string", "null"], "enum": [ "enterprise_actors", "enterprise_and_org_actors", null ], "description": "Who can edit the values of the property", "examples": ["enterprise_actors"] } }, "required": ["property_name", "value_type"] } ] }, "custom-property-base": { "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property" }, "url": { "type": "string", "format": "uri", "description": "The URL that can be used to fetch, update, or delete info about this property via the API." }, "source_type": { "type": "string", "description": "The source type of the property", "enum": ["organization", "enterprise"], "examples": ["organization"] }, "value_type": { "type": "string", "enum": [ "string", "single_select", "multi_select", "true_false", "url" ], "description": "The type of the value for the property", "examples": ["single_select"] }, "required": { "type": "boolean", "description": "Whether the property is required." }, "default_value": { "oneOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Default value of the property", "type": ["null", "string", "array"] }, "description": { "type": ["string", "null"], "description": "Short description of the property" }, "allowed_values": { "type": ["array", "null"], "items": { "type": "string" }, "description": "An ordered list of the allowed values of the property.\nThe property can have up to 200 allowed values." } } }, "webhook-organization-custom-property-deleted": { "title": "organization custom property deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "definition": { "type": "object", "properties": { "property_name": { "type": "string", "description": "The name of the property that was deleted." } }, "required": ["property_name"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition", "enterprise"] }, "webhook-organization-custom-property-updated": { "title": "organization custom property updated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["updated"] }, "definition": { "$ref": "#/components/schemas/organization-custom-property" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "definition", "enterprise"] }, "webhook-organization-custom-property-values-updated": { "title": "Custom property values updated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["updated"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "new_property_values": { "type": "array", "description": "The new custom property values.", "items": { "$ref": "#/components/schemas/custom-property-value" } }, "old_property_values": { "type": "array", "description": "The old custom property values.", "items": { "$ref": "#/components/schemas/custom-property-value" } } }, "required": [ "action", "organization", "enterprise", "new_property_values", "old_property_values" ] }, "webhook-organization-deleted": { "title": "organization deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "membership": { "$ref": "#/components/schemas/webhooks_membership" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "organization", "sender"] }, "webhooks_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" }, "direct_membership": { "type": "boolean", "description": "Whether the user has direct membership in the organization.", "examples": [true] }, "enterprise_teams_providing_indirect_membership": { "type": "array", "description": "The slugs of the enterprise teams providing the user with indirect membership in the organization.\nA limit of 100 enterprise team slugs is returned.", "maxItems": 100, "items": { "type": "string" }, "examples": ["ent:team-one", "ent:team-two"] }, "state": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["url", "state", "role", "organization_url", "user"] }, "webhook-organization-member-added": { "title": "organization member_added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["member_added"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "membership": { "$ref": "#/components/schemas/webhooks_membership" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "membership", "organization", "sender"] }, "webhook-organization-member-invited": { "title": "organization member_invited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "failed_at": { "type": ["string", "null"], "format": "date-time" }, "failed_reason": { "type": ["string", "null"] }, "id": { "type": "number" }, "invitation_teams_url": { "type": "string", "format": "uri" }, "inviter": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "login": { "type": ["string", "null"] }, "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" }, "user": { "$ref": "#/components/schemas/webhooks_user" } }, "required": ["action", "invitation", "organization", "sender"] }, "webhook-organization-member-removed": { "title": "organization member_removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["member_removed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "membership": { "$ref": "#/components/schemas/webhooks_membership" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "membership", "organization", "sender"] }, "webhook-organization-renamed": { "title": "organization renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_membership" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "organization", "sender"] }, "webhook-package-published": { "title": "package published event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "description": { "type": ["string", "null"] }, "ecosystem": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "package_type": { "type": "string" }, "package_version": { "type": ["object", "null"], "properties": { "author": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "body": { "oneOf": [{ "type": "string" }, { "type": "object" }] }, "body_html": { "type": "string" }, "container_metadata": { "type": ["object", "null"], "properties": { "labels": { "type": ["object", "null"] }, "manifest": { "type": ["object", "null"] }, "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", "null"], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "npm_user": { "type": "string" }, "author": { "type": ["object", "null"] }, "bugs": { "type": ["object", "null"] }, "dependencies": { "type": "object" }, "dev_dependencies": { "type": "object" }, "peer_dependencies": { "type": "object" }, "optional_dependencies": { "type": "object" }, "description": { "type": "string" }, "dist": { "type": ["object", "null"] }, "git_head": { "type": "string" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "main": { "type": "string" }, "repository": { "type": ["object", "null"] }, "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", "null"] }, "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", "null"], "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", "null"] }, "name": { "type": "string" }, "sha1": { "type": ["string", "null"] }, "sha256": { "type": ["string", "null"] }, "size": { "type": "integer" }, "state": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "created_at": { "type": "string" }, "draft": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "name": { "type": ["string", "null"] }, "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", "null"], "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", "null"] } }, "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" } }, "required": ["action", "package", "sender"] }, "webhook-rubygems-metadata": { "title": "Ruby Gems metadata", "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "readme": { "type": "string" }, "homepage": { "type": "string" }, "version_info": { "type": "object", "properties": { "version": { "type": "string" } } }, "platform": { "type": "string" }, "metadata": { "type": "object", "additionalProperties": { "type": "string" } }, "repo": { "type": "string" }, "dependencies": { "type": "array", "items": { "type": "object", "additionalProperties": { "type": "string" } } }, "commit_oid": { "type": "string" } } }, "webhook-package-updated": { "title": "package updated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "ecosystem": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "name": { "type": "string" }, "namespace": { "type": "string" }, "owner": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "package_type": { "type": "string" }, "package_version": { "type": "object", "properties": { "author": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "name": { "type": "string" }, "sha1": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "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" } }, "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-cloud@latest/rest/pages/pages#list-github-pages-builds) itself.", "type": "object", "properties": { "commit": { "type": ["string", "null"] }, "created_at": { "type": "string" }, "duration": { "type": "integer" }, "error": { "type": "object", "properties": { "message": { "type": ["string", "null"] } }, "required": ["message"] }, "pusher": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" }, "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" } }, "required": ["id", "build", "repository", "sender"] }, "webhook-personal-access-token-request-approved": { "title": "personal_access_token_request approved event", "type": "object", "properties": { "action": { "type": "string", "enum": ["approved"] }, "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" } }, "required": [ "action", "personal_access_token_request", "organization", "sender", "installation" ] }, "personal-access-token-request": { "title": "Personal Access Token Request", "description": "Details of a Personal Access Token Request.", "type": "object", "properties": { "id": { "type": "integer", "description": "Unique identifier of the request for access via fine-grained personal access token. Used as the `pat_request_id` parameter in the list and review API calls." }, "owner": { "$ref": "#/components/schemas/simple-user" }, "permissions_added": { "type": "object", "description": "New requested permissions, categorized by type of permission.", "properties": { "organization": { "type": "object", "additionalProperties": { "type": "string" } }, "repository": { "type": "object", "additionalProperties": { "type": "string" } }, "other": { "type": "object", "additionalProperties": { "type": "string" } } } }, "permissions_upgraded": { "type": "object", "description": "Requested permissions that elevate access for a previously approved request for access, categorized by type of permission.", "properties": { "organization": { "type": "object", "additionalProperties": { "type": "string" } }, "repository": { "type": "object", "additionalProperties": { "type": "string" } }, "other": { "type": "object", "additionalProperties": { "type": "string" } } } }, "permissions_result": { "type": "object", "description": "Permissions requested, categorized by type of permission. This field incorporates `permissions_added` and `permissions_upgraded`.", "properties": { "organization": { "type": "object", "additionalProperties": { "type": "string" } }, "repository": { "type": "object", "additionalProperties": { "type": "string" } }, "other": { "type": "object", "additionalProperties": { "type": "string" } } } }, "repository_selection": { "type": "string", "description": "Type of repository selection requested.", "enum": ["none", "all", "subset"] }, "repository_count": { "description": "The number of repositories the token is requesting access to. This field is only populated when `repository_selection` is `subset`.", "type": ["integer", "null"] }, "repositories": { "type": ["array", "null"], "description": "An array of repository objects the token is requesting access to. This field is only populated when `repository_selection` is `subset`.", "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"] } }, "created_at": { "type": "string", "description": "Date and time when the request for access was created." }, "token_id": { "type": "integer", "description": "Unique identifier of the user's token. This field can also be found in audit log events and the organization's settings for their PAT grants." }, "token_name": { "type": "string", "description": "The name given to the user's token. This field can also be found in an organization's settings page for Active Tokens." }, "token_expired": { "type": "boolean", "description": "Whether the associated fine-grained personal access token has expired." }, "token_expires_at": { "type": ["string", "null"], "description": "Date and time when the associated fine-grained personal access token expires." }, "token_last_used_at": { "type": ["string", "null"], "description": "Date and time when the associated fine-grained personal access token was last used for authentication." } }, "required": [ "id", "owner", "permissions_added", "permissions_upgraded", "permissions_result", "repository_selection", "repository_count", "repositories", "created_at", "token_id", "token_name", "token_expired", "token_expires_at", "token_last_used_at" ] }, "webhook-personal-access-token-request-cancelled": { "title": "personal_access_token_request cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["cancelled"] }, "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" } }, "required": [ "action", "personal_access_token_request", "organization", "sender", "installation" ] }, "webhook-personal-access-token-request-created": { "title": "personal_access_token_request created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" } }, "required": [ "action", "personal_access_token_request", "organization", "sender" ] }, "webhook-personal-access-token-request-denied": { "title": "personal_access_token_request denied event", "type": "object", "properties": { "action": { "type": "string", "enum": ["denied"] }, "personal_access_token_request": { "$ref": "#/components/schemas/personal-access-token-request" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "installation": { "$ref": "#/components/schemas/simple-installation" } }, "required": [ "action", "personal_access_token_request", "organization", "sender", "installation" ] }, "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" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "zen": { "description": "Random string of GitHub zen.", "type": "string" } } }, "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`.", "examples": ["\"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.**", "examples": ["\"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-cloud@latest/webhooks/event-payloads/#delivery-headers).", "examples": ["\"********\""] }, "webhook-config-url": { "type": "string", "description": "The URL to which the payloads will be delivered.", "format": "uri", "examples": ["https://example.com/webhook"] }, "hook-response": { "title": "Hook Response", "type": "object", "properties": { "code": { "type": ["integer", "null"] }, "status": { "type": ["string", "null"] }, "message": { "type": ["string", "null"] } }, "required": ["code", "status", "message"] }, "webhook-project-card-converted": { "title": "project_card converted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_project_card" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "project_card", "sender"] }, "webhooks_project_card": { "title": "Project Card", "type": "object", "properties": { "after_id": { "type": ["integer", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "id": { "description": "The project card's ID", "type": "integer" }, "node_id": { "type": "string" }, "note": { "type": ["string", "null"] }, "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" ] }, "webhook-project-card-created": { "title": "project_card created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project_card": { "$ref": "#/components/schemas/webhooks_project_card" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project_card", "sender"] }, "webhook-project-card-deleted": { "title": "project_card deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "archived": { "description": "Whether or not the card is archived", "type": "boolean" }, "column_id": { "type": ["integer", "null"] }, "column_url": { "type": "string", "format": "uri" }, "content_url": { "type": "string", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "id": { "description": "The project card's ID", "type": "integer" }, "node_id": { "type": "string" }, "note": { "type": ["string", "null"] }, "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": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/repository-webhooks" } ] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project_card", "sender"] }, "webhook-project-card-edited": { "title": "project_card edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "type": "object", "properties": { "note": { "type": "object", "properties": { "from": { "type": ["string", "null"] } }, "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": { "$ref": "#/components/schemas/webhooks_project_card" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "project_card", "sender"] }, "webhook-project-card-moved": { "title": "project_card moved event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "id": { "description": "The project card's ID", "type": "integer" }, "node_id": { "type": "string" }, "note": { "type": ["string", "null"] }, "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", "null"] }, "archived": { "type": "boolean" }, "column_id": { "type": "integer" }, "column_url": { "type": "string" }, "created_at": { "type": "string" }, "creator": { "type": ["object", "null"], "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", "null"] }, "project_url": { "type": "string" }, "updated_at": { "type": "string" }, "url": { "type": "string" } }, "required": ["after_id"] } ] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project_card", "sender"] }, "webhook-project-closed": { "title": "project closed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["closed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project": { "$ref": "#/components/schemas/webhooks_project" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project", "sender"] }, "webhooks_project": { "title": "Project", "type": "object", "properties": { "body": { "description": "Body of the project", "type": ["string", "null"] }, "columns_url": { "type": "string", "format": "uri" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhook-project-column-created": { "title": "project_column created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project_column": { "$ref": "#/components/schemas/webhooks_project_column" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project_column"] }, "webhooks_project_column": { "title": "Project Column", "type": "object", "properties": { "after_id": { "type": ["integer", "null"] }, "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" ] }, "webhook-project-column-deleted": { "title": "project_column deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project_column": { "$ref": "#/components/schemas/webhooks_project_column" }, "repository": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/repository-webhooks" } ] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project_column"] }, "webhook-project-column-edited": { "title": "project_column edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_project_column" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "project_column"] }, "webhook-project-column-moved": { "title": "project_column moved event", "type": "object", "properties": { "action": { "type": "string", "enum": ["moved"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project_column": { "$ref": "#/components/schemas/webhooks_project_column" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project_column", "sender"] }, "webhook-project-created": { "title": "project created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project": { "$ref": "#/components/schemas/webhooks_project" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project", "sender"] }, "webhook-project-deleted": { "title": "project deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project": { "$ref": "#/components/schemas/webhooks_project" }, "repository": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/repository-webhooks" } ] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project"] }, "webhook-project-edited": { "title": "project edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_project" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project"] }, "webhook-project-reopened": { "title": "project reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["reopened"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "project": { "$ref": "#/components/schemas/webhooks_project" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "project", "sender"] }, "webhook-projects-v2-project-closed": { "title": "Projects v2 Project Closed Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "projects_v2", "organization", "sender"] }, "projects-v2": { "title": "Projects v2 Project", "description": "A projects v2 project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project." }, "node_id": { "type": "string", "description": "The node ID of the project." }, "owner": { "$ref": "#/components/schemas/simple-user" }, "creator": { "$ref": "#/components/schemas/simple-user" }, "title": { "type": "string", "description": "The project title." }, "description": { "type": ["string", "null"], "description": "A short description of the project." }, "public": { "type": "boolean", "description": "Whether the project is visible to anyone with access to the owner." }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "The time when the project was closed.", "examples": ["2022-04-28T12:00:00Z"] }, "created_at": { "type": "string", "format": "date-time", "description": "The time when the project was created.", "examples": ["2022-04-28T12:00:00Z"] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the project was last updated.", "examples": ["2022-04-28T12:00:00Z"] }, "number": { "type": "integer", "description": "The project number." }, "short_description": { "type": ["string", "null"], "description": "A concise summary of the project." }, "deleted_at": { "type": ["string", "null"], "format": "date-time", "description": "The time when the project was deleted.", "examples": ["2022-04-28T12:00:00Z"] }, "deleted_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "state": { "type": "string", "enum": ["open", "closed"], "description": "The current state of the project." }, "latest_status_update": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/projects-v2-status-update" } ] }, "is_template": { "type": "boolean", "description": "Whether this project is a template" } }, "required": [ "id", "node_id", "owner", "creator", "title", "description", "public", "closed_at", "created_at", "updated_at", "number", "short_description", "deleted_at", "deleted_by" ] }, "projects-v2-status-update": { "title": "Projects v2 Status Update", "description": "An status update belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the status update." }, "node_id": { "type": "string", "description": "The node ID of the status update." }, "project_node_id": { "type": "string", "description": "The node ID of the project that this status update belongs to." }, "creator": { "$ref": "#/components/schemas/simple-user" }, "created_at": { "type": "string", "format": "date-time", "description": "The time when the status update was created.", "examples": ["2022-04-28T12:00:00Z"] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the status update was last updated.", "examples": ["2022-04-28T12:00:00Z"] }, "status": { "type": ["string", "null"], "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ], "description": "The current status." }, "start_date": { "type": "string", "format": "date", "description": "The start date of the period covered by the update.", "examples": ["2022-04-28"] }, "target_date": { "type": "string", "format": "date", "description": "The target date associated with the update.", "examples": ["2022-04-28"] }, "body": { "description": "Body of the status update", "type": ["string", "null"], "examples": ["The project is off to a great start!"] } }, "required": ["id", "node_id", "created_at", "updated_at"] }, "webhook-projects-v2-project-created": { "description": "A project was created", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "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"] }, "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" } }, "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"] }, "changes": { "type": "object", "properties": { "description": { "type": "object", "properties": { "from": { "type": ["string", "null"] }, "to": { "type": ["string", "null"] } } }, "public": { "type": "object", "properties": { "from": { "type": "boolean" }, "to": { "type": "boolean" } } }, "short_description": { "type": "object", "properties": { "from": { "type": ["string", "null"] }, "to": { "type": ["string", "null"] } } }, "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" } }, "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"] }, "changes": { "$ref": "#/components/schemas/webhooks_project_changes" }, "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" } }, "required": [ "action", "projects_v2_item", "organization", "sender", "changes" ] }, "webhooks_project_changes": { "type": "object", "properties": { "archived_at": { "type": "object", "properties": { "from": { "type": ["string", "null"], "format": "date-time" }, "to": { "type": ["string", "null"], "format": "date-time" } } } } }, "projects-v2-item": { "title": "Projects v2 Item", "description": "An item belonging to a project", "type": "object", "properties": { "id": { "type": "number", "description": "The unique identifier of the project item." }, "node_id": { "type": "string", "description": "The node ID of the project item." }, "project_node_id": { "type": "string", "description": "The node ID of the project that contains this item." }, "content_node_id": { "type": "string", "description": "The node ID of the content represented by this item." }, "content_type": { "$ref": "#/components/schemas/projects-v2-item-content-type" }, "creator": { "$ref": "#/components/schemas/simple-user" }, "created_at": { "type": "string", "format": "date-time", "description": "The time when the item was created.", "examples": ["2022-04-28T12:00:00Z"] }, "updated_at": { "type": "string", "format": "date-time", "description": "The time when the item was last updated.", "examples": ["2022-04-28T12:00:00Z"] }, "archived_at": { "type": ["string", "null"], "format": "date-time", "description": "The time when the item was archived.", "examples": ["2022-04-28T12:00:00Z"] } }, "required": [ "id", "content_node_id", "content_type", "created_at", "updated_at", "archived_at" ] }, "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"] }, "webhook-projects-v2-item-converted": { "title": "Projects v2 Item Converted Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["converted"] }, "changes": { "type": "object", "properties": { "content_type": { "type": "object", "properties": { "from": { "type": ["string", "null"] }, "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" } }, "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"] }, "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" } }, "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"] }, "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" } }, "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"] }, "changes": { "description": "The changes made to the item may involve modifications in the item's fields and draft issue body.\nIt includes altered values for text, number, date, single select, and iteration fields, along with the GraphQL node ID of the changed field.", "oneOf": [ { "type": "object", "properties": { "field_value": { "type": "object", "properties": { "field_node_id": { "type": "string" }, "field_type": { "type": "string" }, "field_name": { "type": "string" }, "project_number": { "type": "integer" }, "from": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "$ref": "#/components/schemas/projects-v2-single-select-option" }, { "$ref": "#/components/schemas/projects-v2-iteration-setting" } ], "type": ["null", "string", "integer", "object"] }, "to": { "oneOf": [ { "type": "string" }, { "type": "integer" }, { "$ref": "#/components/schemas/projects-v2-single-select-option" }, { "$ref": "#/components/schemas/projects-v2-iteration-setting" } ], "type": ["null", "string", "integer", "object"] } } } }, "required": ["field_value"] }, { "type": "object", "properties": { "body": { "type": "object", "properties": { "from": { "type": ["string", "null"] }, "to": { "type": ["string", "null"] } } } }, "required": ["body"] } ] }, "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" } }, "required": ["action", "projects_v2_item", "organization", "sender"] }, "projects-v2-single-select-option": { "title": "Projects v2 Single Select Option", "description": "An option for a single select field", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the option." }, "name": { "type": "string", "description": "The display name of the option." }, "color": { "type": ["string", "null"], "description": "The color associated with the option." }, "description": { "type": ["string", "null"], "description": "A short description of the option." } }, "required": ["id", "name"] }, "projects-v2-iteration-setting": { "title": "Projects v2 Iteration Setting", "description": "An iteration setting for an iteration field", "type": "object", "properties": { "id": { "type": "string", "description": "The unique identifier of the iteration setting." }, "title": { "type": "string", "description": "The iteration title." }, "title_html": { "type": "string", "description": "The iteration title, rendered as HTML." }, "duration": { "type": ["number", "null"], "description": "The duration of the iteration in days." }, "start_date": { "type": ["string", "null"], "description": "The start date of the iteration." }, "completed": { "type": "boolean", "description": "Whether the iteration has been completed." } }, "required": ["id", "title"] }, "webhook-projects-v2-item-reordered": { "title": "Projects v2 Item Reordered Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["reordered"] }, "changes": { "type": "object", "properties": { "previous_projects_v2_item_node_id": { "type": "object", "properties": { "from": { "type": ["string", "null"] }, "to": { "type": ["string", "null"] } } } } }, "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" } }, "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"] }, "changes": { "$ref": "#/components/schemas/webhooks_project_changes" }, "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" } }, "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"] }, "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" } }, "required": ["action", "projects_v2", "organization", "sender"] }, "webhook-projects-v2-status-update-created": { "title": "Projects v2 Status Update Created Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "projects_v2_status_update": { "$ref": "#/components/schemas/projects-v2-status-update" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "projects_v2_status_update", "organization", "sender" ] }, "webhook-projects-v2-status-update-deleted": { "title": "Projects v2 Status Update Deleted Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "projects_v2_status_update": { "$ref": "#/components/schemas/projects-v2-status-update" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "projects_v2_status_update", "organization", "sender" ] }, "webhook-projects-v2-status-update-edited": { "title": "Projects v2 Status Update Edited Event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "type": "object", "properties": { "body": { "type": "object", "properties": { "from": { "type": ["string", "null"] }, "to": { "type": ["string", "null"] } } }, "status": { "type": "object", "properties": { "from": { "type": ["string", "null"], "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] }, "to": { "type": ["string", "null"], "enum": [ "INACTIVE", "ON_TRACK", "AT_RISK", "OFF_TRACK", "COMPLETE", null ] } } }, "start_date": { "type": "object", "properties": { "from": { "type": ["string", "null"], "format": "date" }, "to": { "type": ["string", "null"], "format": "date" } } }, "target_date": { "type": "object", "properties": { "from": { "type": ["string", "null"], "format": "date" }, "to": { "type": ["string", "null"], "format": "date" } } } } }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "projects_v2_status_update": { "$ref": "#/components/schemas/projects-v2-status-update" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "projects_v2_status_update", "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" } }, "required": ["repository", "sender"] }, "webhook-pull-request-assigned": { "title": "pull_request assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["assigned"] }, "assignee": { "$ref": "#/components/schemas/webhooks_user" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "assignee", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhooks_number": { "description": "The pull request number.", "type": "integer" }, "webhook-pull-request-auto-merge-disabled": { "title": "pull_request auto_merge_disabled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["auto_merge_disabled"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "number", "pull_request", "reason", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-auto-merge-enabled": { "title": "pull_request auto_merge_enabled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["auto_merge_enabled"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-closed": { "title": "pull_request closed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["closed"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/pull-request-webhook" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "number", "pull_request", "repository", "sender"] }, "pull-request-webhook": { "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.\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., \"Merge pull request #123 from branch-name\").", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. Please use `squash_merge_commit_title` instead.**", "type": "boolean", "default": false } } } ] }, "webhook-pull-request-converted-to-draft": { "title": "pull_request converted_to_draft event", "type": "object", "properties": { "action": { "type": "string", "enum": ["converted_to_draft"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/pull-request-webhook" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "number", "pull_request", "repository", "sender"] }, "webhook-pull-request-demilestoned": { "title": "pull_request demilestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["demilestoned"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "milestone": { "$ref": "#/components/schemas/milestone" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/webhooks_pull_request_5" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "number", "pull_request", "repository", "sender"] }, "webhooks_pull_request_5": { "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" ], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": { "properties": { "merge_commit_sha": null }, "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", "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" ] }, "version": "2026-03-10" } ] }, "webhook-pull-request-dequeued": { "title": "pull_request dequeued event", "type": "object", "properties": { "action": { "type": "string", "enum": ["dequeued"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "enum": [ "UNKNOWN_REMOVAL_REASON", "MANUAL", "MERGE", "MERGE_CONFLICT", "CI_FAILURE", "CI_TIMEOUT", "ALREADY_MERGED", "QUEUE_CLEARED", "ROLL_BACK", "BRANCH_PROTECTIONS", "GIT_TREE_INVALID", "INVALID_MERGE_COMMIT" ] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "number", "pull_request", "repository", "sender", "reason" ], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-edited": { "title": "pull_request edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/pull-request-webhook" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "changes", "number", "pull_request", "repository", "sender" ] }, "webhook-pull-request-enqueued": { "title": "pull_request enqueued event", "type": "object", "properties": { "action": { "type": "string", "enum": ["enqueued"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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_discussions", "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-labeled": { "title": "pull_request labeled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["labeled"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "archived_at": { "description": "Timestamp indicating when the label was archived, or `null` if it has not been archived.", "type": ["string", "null"], "format": "date-time" }, "archived_by": { "description": "The user who archived the label, or `null` if it has not been archived.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] }, "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", "archived_at", "archived_by" ] } }, "locked": { "type": "boolean" }, "maintainer_can_modify": { "description": "Indicates whether maintainers can modify the pull request.", "type": "boolean" }, "merge_commit_sha": { "type": ["string", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-locked": { "title": "pull_request locked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["locked"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-milestoned": { "title": "pull_request milestoned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["milestoned"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "milestone": { "$ref": "#/components/schemas/milestone" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/webhooks_pull_request_5" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "number", "pull_request", "repository", "sender"] }, "webhook-pull-request-opened": { "title": "pull_request opened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["opened"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/pull-request-webhook" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/pull-request-webhook" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "number", "pull_request", "repository", "sender"] }, "webhook-pull-request-reopened": { "title": "pull_request reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["reopened"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "pull_request": { "$ref": "#/components/schemas/pull-request-webhook" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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"] }, "comment": { "title": "Pull Request Review Comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/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", "null"] }, "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", "null"] }, "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", "null"] }, "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", "null"] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": ["integer", "null"] }, "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", "null"] }, "start_side": { "description": "The side of the first line of the range for a multi-line comment.", "type": ["string", "null"], "enum": ["LEFT", "RIGHT", null], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "comment", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-review-comment-deleted": { "title": "pull_request_review_comment deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "comment": { "$ref": "#/components/schemas/webhooks_review_comment" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "comment", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhooks_review_comment": { "title": "Pull Request Review Comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/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", "null"] }, "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", "null"] }, "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", "null"] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": ["integer", "null"] }, "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", "null"] }, "start_side": { "description": "The side of the first line of the range for a multi-line comment.", "type": ["string", "null"], "enum": ["LEFT", "RIGHT", null], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhook-pull-request-review-comment-edited": { "title": "pull_request_review_comment edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "$ref": "#/components/schemas/webhooks_changes" }, "comment": { "$ref": "#/components/schemas/webhooks_review_comment" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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"] }, "user_view_type": { "type": "string" }, "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" } }, "required": [ "action", "changes", "comment", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-review-dismissed": { "title": "pull_request_review dismissed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "review", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-review-edited": { "title": "pull_request_review edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"], "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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": { "$ref": "#/components/schemas/webhooks_review" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "changes", "review", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "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", "null"] }, "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", "null"], "format": "date-time" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "user": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": [ "id", "node_id", "user", "body", "commit_id", "submitted_at", "state", "html_url", "pull_request_url", "author_association", "_links" ] }, "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", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" } }, "required": [ "requested_team", "action", "number", "pull_request", "repository", "sender" ] } ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/oneOf/0/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/oneOf/0/properties/pull_request/required/17" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "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", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "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", "null"], "enum": [ "resolved", "off-topic", "too heated", "spam", null ] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" } }, "required": [ "requested_team", "action", "number", "pull_request", "repository", "sender" ] } ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/oneOf/0/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/oneOf/0/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/oneOf/0/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/oneOf/0/properties/pull_request/required/17" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/oneOf/1/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-review-submitted": { "title": "pull_request_review submitted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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": { "$ref": "#/components/schemas/webhooks_review" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": [ "action", "review", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-review-thread-resolved": { "title": "pull_request_review_thread resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" }, "thread": { "type": "object", "properties": { "comments": { "type": "array", "items": { "title": "Pull Request Review Comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/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", "null"] }, "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", "null"] }, "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", "null"] }, "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", "null"] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": ["integer", "null"] }, "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", "null"] }, "start_side": { "description": "The side of the first line of the range for a multi-line comment.", "type": ["string", "null"], "enum": ["LEFT", "RIGHT", null], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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"] }, "updated_at": { "type": ["string", "null"], "format": "date-time" } }, "required": ["action", "thread", "pull_request", "repository"], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-review-thread-unresolved": { "title": "pull_request_review_thread unresolved event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": "string" }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "closed_at": { "type": ["string", "null"] }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "merged_at": { "type": ["string", "null"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" }, "thread": { "type": "object", "properties": { "comments": { "type": "array", "items": { "title": "Pull Request Review Comment", "description": "The [comment](https://docs.github.com/enterprise-cloud@latest/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", "null"] }, "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", "null"] }, "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", "null"] }, "pull_request_review_id": { "description": "The ID of the pull request review to which the comment belongs.", "type": ["integer", "null"] }, "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", "null"] }, "start_side": { "description": "The side of the first line of the range for a multi-line comment.", "type": ["string", "null"], "enum": ["LEFT", "RIGHT", null], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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"] }, "updated_at": { "type": ["string", "null"], "format": "date-time" } }, "required": ["action", "thread", "pull_request", "repository"], "x-github-breaking-changes": [ { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-stacked": { "title": "pull_request stacked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["stacked"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-synchronize": { "title": "pull_request synchronize event", "type": "object", "properties": { "action": { "type": "string", "enum": ["synchronize"] }, "after": { "type": "string" }, "before": { "type": "string" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "before", "after", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-unassigned": { "title": "pull_request unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unassigned"] }, "assignee": { "$ref": "#/components/schemas/webhooks_user_mannequin" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-unlabeled": { "title": "pull_request unlabeled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unlabeled"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "label": { "$ref": "#/components/schemas/webhooks_label" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": ["string", "null"] }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"] }, "ref": { "type": "string" }, "repo": { "title": "Repository", "description": "A git repository", "type": ["object", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "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" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-pull-request-unlocked": { "title": "pull_request unlocked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unlocked"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "number": { "$ref": "#/components/schemas/webhooks_number" }, "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", "null"], "enum": ["resolved", "off-topic", "too heated", "spam", null] }, "additions": { "type": "integer" }, "assignee": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "assignees": { "type": "array", "items": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "null"], "properties": { "commit_message": { "description": "Commit message for the merge commit.", "type": ["string", "null"] }, "commit_title": { "description": "Title for the merge commit message.", "type": "string" }, "enabled_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] } }, "required": ["label", "ref", "sha", "user", "repo"] }, "body": { "type": ["string", "null"] }, "changed_files": { "type": "integer" }, "closed_at": { "type": ["string", "null"], "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", "null"], "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `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.\n\n- `PR_TITLE` - default to the pull request's title.\n- `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"] }, "merges_url": { "type": "string", "format": "uri" }, "milestones_url": { "type": "string", "format": "uri-template" }, "mirror_url": { "type": ["string", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "size": { "type": "integer" }, "squash_merge_commit_message": { "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `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:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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 is closing down. 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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"] }, "mergeable": { "type": ["boolean", "null"] }, "mergeable_state": { "type": "string" }, "merged": { "type": ["boolean", "null"] }, "merged_at": { "type": ["string", "null"], "format": "date-time" }, "merged_by": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "milestone": { "title": "Milestone", "description": "A collection of related issues and pull requests.", "type": ["object", "null"], "properties": { "closed_at": { "type": ["string", "null"], "format": "date-time" }, "closed_issues": { "type": "integer" }, "created_at": { "type": "string", "format": "date-time" }, "creator": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "description": { "type": ["string", "null"] }, "due_on": { "type": ["string", "null"], "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", "null"] }, "requested_reviewers": { "type": "array", "items": { "oneOf": [ { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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" }, "stack": { "$ref": "#/components/schemas/pull-request-stack" }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" } }, "required": [ "action", "number", "pull_request", "repository", "sender" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/base/properties/repo/properties/use_squash_pr_title_as_default" }, { "op": "remove", "path": "/properties/pull_request/properties/head/properties/repo/properties/use_squash_pr_title_as_default" } ], "version": "2026-03-10" }, { "changeset": "remove_pull_request_merge_commit_sha", "patch": [ { "op": "remove", "path": "/properties/pull_request/properties/merge_commit_sha" }, { "op": "remove", "path": "/properties/pull_request/required/17" } ], "version": "2026-03-10" } ] }, "webhook-push": { "title": "push event", "type": "object", "properties": { "after": { "description": "The SHA of the most recent commit on `ref` after the push.", "type": "string" }, "base_ref": { "$ref": "#/components/schemas/webhooks_nullable_string" }, "before": { "description": "The SHA of the most recent commit on `ref` before the push.", "type": "string" }, "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-cloud@latest/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", "null"], "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", "null"], "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" }, "created": { "description": "Whether this push created the `ref`.", "type": "boolean" }, "deleted": { "description": "Whether this push deleted the `ref`.", "type": "boolean" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "forced": { "description": "Whether this push was a force push of the `ref`.", "type": "boolean" }, "head_commit": { "title": "Commit", "type": ["object", "null"], "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", "null"], "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", "null"], "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", "null"], "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" }, "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" } ] }, "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", "null"] }, "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 }, "has_pull_requests": { "description": "Whether pull requests are enabled.", "type": "boolean", "default": true }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"] }, "homepage": { "type": ["string", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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" } }, "required": [ "ref", "before", "after", "created", "deleted", "forced", "base_ref", "compare", "commits", "head_commit", "repository", "pusher" ] }, "webhooks_nullable_string": { "type": ["string", "null"] }, "webhook-registry-package-published": { "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "description": { "type": ["string", "null"] }, "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" }, "user_view_type": { "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", "null"], "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" }, "user_view_type": { "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", "null"] }, "manifest": { "type": ["object", "null"] }, "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", "null"], "properties": { "name": { "type": "string" }, "version": { "type": "string" }, "npm_user": { "type": "string" }, "author": { "oneOf": [{ "type": "string" }, { "type": "object" }], "type": ["null", "string", "object"] }, "bugs": { "oneOf": [{ "type": "string" }, { "type": "object" }], "type": ["null", "string", "object"] }, "dependencies": { "type": "object" }, "dev_dependencies": { "type": "object" }, "peer_dependencies": { "type": "object" }, "optional_dependencies": { "type": "object" }, "description": { "type": "string" }, "dist": { "oneOf": [{ "type": "string" }, { "type": "object" }], "type": ["null", "string", "object"] }, "git_head": { "type": "string" }, "homepage": { "type": "string" }, "license": { "type": "string" }, "main": { "type": "string" }, "repository": { "oneOf": [{ "type": "string" }, { "type": "object" }], "type": ["null", "string", "object"] }, "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" }], "type": ["null", "string", "object"] }, "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", "null"], "items": { "type": "object", "properties": { "id": { "oneOf": [ { "type": "string" }, { "type": "object" }, { "type": "integer" } ], "type": ["null", "string", "object", "integer"] }, "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", "null"] }, "name": { "type": "string" }, "sha1": { "type": ["string", "null"] }, "sha256": { "type": ["string", "null"] }, "size": { "type": "integer" }, "state": { "type": ["string", "null"] }, "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" }, "user_view_type": { "type": "string" } } }, "created_at": { "type": "string" }, "draft": { "type": "boolean" }, "html_url": { "type": "string" }, "id": { "type": "integer" }, "name": { "type": ["string", "null"] }, "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", "null"], "properties": { "about_url": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "url": { "type": "string" }, "vendor": { "type": "string" } } }, "updated_at": { "type": ["string", "null"] } }, "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" } }, "required": ["action", "registry_package", "sender"] }, "webhook-registry-package-updated": { "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "type": ["null"] }, "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" }, "user_view_type": { "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" }, "user_view_type": { "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", "null"], "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", "null"] }, "name": { "type": "string" }, "sha1": { "type": ["string", "null"] }, "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" }, "user_view_type": { "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", "null"] }, "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" } }, "required": ["action", "registry_package", "sender"] }, "webhook-release-created": { "title": "release created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["created"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "release": { "$ref": "#/components/schemas/webhooks_release" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "release", "repository", "sender"] }, "webhooks_release": { "title": "Release", "description": "The [release](https://docs.github.com/enterprise-cloud@latest/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", "null"] }, "name": { "description": "The file name of the asset.", "type": "string" }, "node_id": { "type": "string" }, "size": { "type": "integer" }, "digest": { "type": ["string", "null"] }, "state": { "description": "State of the release asset.", "type": "string", "enum": ["uploaded"] }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "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", "digest", "content_type", "size", "download_count", "created_at", "updated_at" ] } }, "assets_url": { "type": "string", "format": "uri" }, "author": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "body": { "type": ["string", "null"] }, "created_at": { "type": ["string", "null"], "format": "date-time" }, "updated_at": { "type": ["string", "null"], "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" }, "immutable": { "description": "Whether or not the release is immutable.", "type": "boolean" }, "name": { "type": ["string", "null"] }, "node_id": { "type": "string" }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", "type": "boolean" }, "published_at": { "type": ["string", "null"], "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", "null"], "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", "null"], "format": "uri" } }, "required": [ "url", "assets_url", "upload_url", "html_url", "id", "node_id", "tag_name", "target_commitish", "name", "draft", "author", "prerelease", "immutable", "created_at", "published_at", "assets", "tarball_url", "updated_at", "zipball_url", "body" ] }, "webhook-release-deleted": { "title": "release deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["deleted"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "release": { "$ref": "#/components/schemas/webhooks_release" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "release", "repository", "sender"] }, "webhook-release-edited": { "title": "release edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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"] }, "tag_name": { "type": "object", "properties": { "from": { "description": "The previous version of the tag_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": { "$ref": "#/components/schemas/webhooks_release" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "changes", "release", "repository"] }, "webhook-release-prereleased": { "title": "release prereleased event", "type": "object", "properties": { "action": { "type": "string", "enum": ["prereleased"] }, "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-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", "assets_url", "author", "body", "created_at", "draft", "html_url", "id", "immutable", "name", "node_id", "prerelease", "published_at", "tag_name", "tarball_url", "target_commitish", "updated_at", "upload_url", "url", "zipball_url" ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": ["object", "null"], "required": [ "url", "browser_download_url", "id", "node_id", "name", "label", "state", "digest", "content_type", "size", "download_count", "created_at", "updated_at" ], "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", "null"] }, "name": { "description": "The file name of the asset.", "type": "string" }, "node_id": { "type": "string" }, "size": { "type": "integer" }, "digest": { "type": ["string", "null"] }, "state": { "description": "State of the release asset.", "type": "string", "enum": ["uploaded"] }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "url": { "type": "string", "format": "uri" } } } }, "assets_url": { "type": "string", "format": "uri" }, "author": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "body": { "type": ["string", "null"] }, "created_at": { "type": ["string", "null"], "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" }, "immutable": { "description": "Whether or not the release is immutable.", "type": "boolean" }, "name": { "type": ["string", "null"] }, "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", "null"], "format": "date-time" }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "tag_name": { "description": "The name of the tag.", "type": "string" }, "tarball_url": { "type": ["string", "null"], "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" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "url": { "type": "string", "format": "uri" }, "zipball_url": { "type": ["string", "null"], "format": "uri" } } }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "release", "repository"] }, "webhook-release-published": { "title": "release published event", "type": "object", "properties": { "action": { "type": "string", "enum": ["published"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "release": { "$ref": "#/components/schemas/webhooks_release_1" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "release", "repository"] }, "webhooks_release_1": { "title": "Release", "description": "The [release](https://docs.github.com/enterprise-cloud@latest/rest/releases/releases/#get-a-release) object.", "type": "object", "required": [ "assets", "assets_url", "author", "body", "created_at", "draft", "html_url", "id", "name", "node_id", "prerelease", "immutable", "published_at", "tag_name", "tarball_url", "target_commitish", "updated_at", "upload_url", "url", "zipball_url" ], "properties": { "assets": { "type": "array", "items": { "title": "Release Asset", "description": "Data related to a release.", "type": ["object", "null"], "required": [ "url", "browser_download_url", "id", "node_id", "name", "label", "state", "content_type", "size", "digest", "download_count", "created_at", "updated_at" ], "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", "null"] }, "name": { "description": "The file name of the asset.", "type": "string" }, "node_id": { "type": "string" }, "size": { "type": "integer" }, "digest": { "type": ["string", "null"] }, "state": { "description": "State of the release asset.", "type": "string", "enum": ["uploaded"] }, "updated_at": { "type": "string", "format": "date-time" }, "uploader": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "url": { "type": "string", "format": "uri" } } } }, "assets_url": { "type": "string", "format": "uri" }, "author": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "body": { "type": ["string", "null"] }, "created_at": { "type": ["string", "null"], "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" }, "immutable": { "description": "Whether or not the release is immutable.", "type": "boolean" }, "name": { "type": ["string", "null"] }, "node_id": { "type": "string" }, "prerelease": { "description": "Whether the release is identified as a prerelease or a full release.", "type": "boolean" }, "published_at": { "type": ["string", "null"], "format": "date-time" }, "reactions": { "title": "Reactions", "type": "object", "required": [ "url", "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", "eyes", "rocket" ], "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" } } }, "tag_name": { "description": "The name of the tag.", "type": "string" }, "tarball_url": { "type": ["string", "null"], "format": "uri" }, "target_commitish": { "description": "Specifies the commitish value that determines where the Git tag is created from.", "type": "string" }, "updated_at": { "type": ["string", "null"], "format": "date-time" }, "upload_url": { "type": "string", "format": "uri-template" }, "url": { "type": "string", "format": "uri" }, "zipball_url": { "type": ["string", "null"], "format": "uri" } } }, "webhook-release-released": { "title": "release released event", "type": "object", "properties": { "action": { "type": "string", "enum": ["released"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "release": { "$ref": "#/components/schemas/webhooks_release" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "release", "repository"] }, "webhook-release-unpublished": { "title": "release unpublished event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unpublished"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "release": { "$ref": "#/components/schemas/webhooks_release_1" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "release", "repository"] }, "webhook-repository-advisory-published": { "title": "Repository advisory published event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "repository_advisory": { "$ref": "#/components/schemas/repository-advisory" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "repository", "repository_advisory"] }, "repository-advisory": { "description": "A repository security advisory.", "type": "object", "properties": { "ghsa_id": { "type": "string", "description": "The GitHub Security Advisory ID.", "readOnly": true }, "cve_id": { "type": ["string", "null"], "description": "The Common Vulnerabilities and Exposures (CVE) ID." }, "url": { "type": "string", "format": "uri", "description": "The API URL for the advisory.", "readOnly": true }, "html_url": { "type": "string", "format": "uri", "description": "The URL for the advisory.", "readOnly": true }, "summary": { "type": "string", "description": "A short summary of the advisory.", "maxLength": 1024 }, "description": { "type": ["string", "null"], "description": "A detailed description of what the advisory entails.", "maxLength": 65535 }, "severity": { "type": ["string", "null"], "description": "The severity of the advisory.", "enum": ["critical", "high", "medium", "low", null] }, "author": { "readOnly": true, "description": "The author of the advisory.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] }, "publisher": { "readOnly": true, "description": "The publisher of the advisory.", "allOf": [{ "$ref": "#/components/schemas/simple-user" }], "type": ["null"] }, "identifiers": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "description": "The type of identifier.", "enum": ["CVE", "GHSA"] }, "value": { "type": "string", "description": "The identifier value." } }, "required": ["type", "value"] }, "readOnly": true }, "state": { "type": "string", "description": "The state of the advisory.", "enum": ["published", "closed", "withdrawn", "draft", "triage"] }, "created_at": { "type": ["string", "null"], "format": "date-time", "description": "The date and time of when the advisory was created, in ISO 8601 format.", "readOnly": true }, "updated_at": { "type": ["string", "null"], "format": "date-time", "description": "The date and time of when the advisory was last updated, in ISO 8601 format.", "readOnly": true }, "published_at": { "type": ["string", "null"], "format": "date-time", "description": "The date and time of when the advisory was published, in ISO 8601 format.", "readOnly": true }, "closed_at": { "type": ["string", "null"], "format": "date-time", "description": "The date and time of when the advisory was closed, in ISO 8601 format.", "readOnly": true }, "withdrawn_at": { "type": ["string", "null"], "format": "date-time", "description": "The date and time of when the advisory was withdrawn, in ISO 8601 format.", "readOnly": true }, "submission": { "type": ["object", "null"], "readOnly": true, "properties": { "accepted": { "type": "boolean", "description": "Whether a private vulnerability report was accepted by the repository's administrators.", "readOnly": true } }, "required": ["accepted"] }, "vulnerabilities": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/repository-advisory-vulnerability" } }, "cvss": { "type": ["object", "null"], "properties": { "vector_string": { "type": ["string", "null"], "description": "The CVSS vector." }, "score": { "type": ["number", "null"], "description": "The CVSS score.", "minimum": 0, "maximum": 10, "readOnly": true } }, "required": ["vector_string", "score"] }, "cvss_severities": { "$ref": "#/components/schemas/cvss-severities" }, "cwes": { "type": ["array", "null"], "items": { "type": "object", "properties": { "cwe_id": { "type": "string", "description": "The Common Weakness Enumeration (CWE) identifier." }, "name": { "type": "string", "description": "The name of the CWE.", "readOnly": true } }, "required": ["cwe_id", "name"] }, "readOnly": true }, "cwe_ids": { "type": ["array", "null"], "description": "A list of only the CWE IDs.", "items": { "type": "string" } }, "credits": { "type": ["array", "null"], "items": { "type": "object", "properties": { "login": { "type": "string", "description": "The username of the user credited." }, "type": { "$ref": "#/components/schemas/security-advisory-credit-types" } } } }, "credits_detailed": { "type": ["array", "null"], "items": { "$ref": "#/components/schemas/repository-advisory-credit" }, "readOnly": true }, "collaborating_users": { "type": ["array", "null"], "description": "A list of users that collaborate on the advisory.", "items": { "$ref": "#/components/schemas/simple-user" } }, "collaborating_teams": { "type": ["array", "null"], "description": "A list of teams that collaborate on the advisory.", "items": { "$ref": "#/components/schemas/team" } }, "private_fork": { "readOnly": true, "description": "A temporary private fork of the advisory's repository for collaborating on a fix.", "allOf": [{ "$ref": "#/components/schemas/simple-repository" }], "type": ["null"] } }, "required": [ "ghsa_id", "cve_id", "url", "html_url", "summary", "description", "severity", "author", "publisher", "identifiers", "state", "created_at", "updated_at", "published_at", "closed_at", "withdrawn_at", "submission", "vulnerabilities", "cvss", "cwes", "cwe_ids", "credits", "credits_detailed", "collaborating_users", "collaborating_teams", "private_fork" ], "additionalProperties": false, "x-github-breaking-changes": [ { "changeset": "deprecate_cvss", "patch": { "properties": { "cvss": null }, "required": [ "ghsa_id", "cve_id", "url", "html_url", "summary", "description", "severity", "author", "publisher", "identifiers", "state", "created_at", "updated_at", "published_at", "closed_at", "withdrawn_at", "submission", "vulnerabilities", "cwes", "cwe_ids", "credits", "credits_detailed", "collaborating_users", "collaborating_teams", "private_fork" ] }, "version": "2026-03-10" } ] }, "repository-advisory-vulnerability": { "description": "A product affected by the vulnerability detailed in a repository security advisory.", "type": "object", "properties": { "package": { "description": "The name of the package affected by the vulnerability.", "type": ["object", "null"], "properties": { "ecosystem": { "$ref": "#/components/schemas/security-advisory-ecosystems" }, "name": { "type": ["string", "null"], "description": "The unique package name within its ecosystem." } }, "required": ["ecosystem", "name"] }, "vulnerable_version_range": { "type": ["string", "null"], "description": "The range of the package versions affected by the vulnerability." }, "patched_versions": { "type": ["string", "null"], "description": "The package version(s) that resolve the vulnerability." }, "vulnerable_functions": { "type": ["array", "null"], "description": "The functions in the package that are affected.", "items": { "type": "string" } } }, "required": [ "package", "vulnerable_version_range", "patched_versions", "vulnerable_functions" ], "additionalProperties": false }, "security-advisory-ecosystems": { "type": "string", "description": "The package's language or package management ecosystem.", "enum": [ "rubygems", "npm", "pip", "maven", "nuget", "composer", "go", "rust", "erlang", "actions", "pub", "other", "swift" ] }, "security-advisory-credit-types": { "type": "string", "description": "The type of credit the user is receiving.", "enum": [ "analyst", "finder", "reporter", "coordinator", "remediation_developer", "remediation_reviewer", "remediation_verifier", "tool", "sponsor", "other" ] }, "repository-advisory-credit": { "description": "A credit given to a user for a repository security advisory.", "type": "object", "properties": { "user": { "$ref": "#/components/schemas/simple-user" }, "type": { "$ref": "#/components/schemas/security-advisory-credit-types" }, "state": { "type": "string", "description": "The state of the user's acceptance of the credit.", "enum": ["accepted", "declined", "pending"] } }, "required": ["user", "type", "state"], "additionalProperties": false }, "team": { "title": "Team", "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { "id": { "type": "integer" }, "node_id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": ["string", "null"] }, "privacy": { "type": "string" }, "notification_setting": { "type": "string" }, "permission": { "type": "string" }, "permissions": { "type": "object", "properties": { "pull": { "type": "boolean" }, "triage": { "type": "boolean" }, "push": { "type": "boolean" }, "maintain": { "type": "boolean" }, "admin": { "type": "boolean" } }, "required": ["pull", "triage", "push", "maintain", "admin"] }, "url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/orgs/rails/teams/core"] }, "members_url": { "type": "string" }, "repositories_url": { "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": ["enterprise", "organization"] }, "access_source": { "description": "How the team's access to the repository was granted. This property is only\npresent when the team is returned in a repository context, such as\n`GET /repos/{owner}/{repo}/teams`.", "type": "string", "enum": ["direct", "organization", "enterprise"], "examples": ["direct"] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [37] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [42] }, "parent": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/team-simple" } ] } }, "required": [ "id", "node_id", "url", "members_url", "name", "description", "permission", "html_url", "repositories_url", "slug", "parent", "type" ] }, "simple-repository": { "title": "Simple Repository", "description": "A GitHub repository.", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "description": "A unique identifier of the repository.", "examples": [1296269] }, "node_id": { "type": "string", "description": "The GraphQL identifier of the repository.", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "type": "string", "description": "The name of the repository.", "examples": ["Hello-World"] }, "full_name": { "type": "string", "description": "The full, globally unique, name of the repository.", "examples": ["octocat/Hello-World"] }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { "type": "boolean", "description": "Whether the repository is private." }, "html_url": { "type": "string", "format": "uri", "description": "The URL to view the repository on GitHub.com.", "examples": ["https://github.com/octocat/Hello-World"] }, "description": { "type": ["string", "null"], "description": "The repository description.", "examples": ["This your first repo!"] }, "fork": { "type": "boolean", "description": "Whether the repository is a fork." }, "url": { "type": "string", "format": "uri", "description": "The URL to get more information about the repository from the GitHub API.", "examples": ["https://api.github.com/repos/octocat/Hello-World"] }, "archive_url": { "type": "string", "description": "A template for the API URL to download the repository as an archive.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "description": "A template for the API URL to list the available assignees for issues in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "description": "A template for the API URL to create or retrieve a raw Git blob in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "description": "A template for the API URL to get information about branches in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "description": "A template for the API URL to get information about collaborators of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "description": "A template for the API URL to get information about comments on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "description": "A template for the API URL to get information about commits on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "description": "A template for the API URL to compare two commits or refs.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "description": "A template for the API URL to get the contents of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "description": "A template for the API URL to list the contributors to the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "description": "The API URL to list the deployments of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "description": "The API URL to list the downloads on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "description": "The API URL to list the events of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "description": "The API URL to list the forks of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "description": "A template for the API URL to get information about Git commits of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "description": "A template for the API URL to get information about Git refs of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "description": "A template for the API URL to get information about Git tags of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "issue_comment_url": { "type": "string", "description": "A template for the API URL to get information about issue comments on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "description": "A template for the API URL to get information about issue events on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "description": "A template for the API URL to get information about issues on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "description": "A template for the API URL to get information about deploy keys on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "description": "A template for the API URL to get information about labels of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "description": "The API URL to get information about the languages of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "description": "The API URL to merge branches in the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "description": "A template for the API URL to get information about milestones of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "description": "A template for the API URL to get information about notifications on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "description": "A template for the API URL to get information about pull requests on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "description": "A template for the API URL to get information about releases on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "stargazers_url": { "type": "string", "format": "uri", "description": "The API URL to list the stargazers on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "description": "A template for the API URL to get information about statuses of a commit.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "description": "The API URL to list the subscribers on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "description": "The API URL to subscribe to notifications for this repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "description": "The API URL to get information about tags on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/tags" ] }, "teams_url": { "type": "string", "format": "uri", "description": "The API URL to list the teams on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "description": "A template for the API URL to create or retrieve a raw Git tree of the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "hooks_url": { "type": "string", "format": "uri", "description": "The API URL to list the hooks on the repository.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/hooks" ] } }, "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" ] }, "webhook-repository-advisory-reported": { "title": "Repository advisory reported event", "type": "object", "properties": { "action": { "type": "string", "enum": ["reported"] }, "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" }, "repository_advisory": { "$ref": "#/components/schemas/repository-advisory" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "repository", "repository_advisory"] }, "webhook-repository-archived": { "title": "repository archived event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-repository-created": { "title": "repository created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-repository-deleted": { "title": "repository deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-repository-dispatch-sample": { "title": "repository_dispatch event", "type": "object", "properties": { "action": { "type": "string", "description": "The `event_type` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request body." }, "branch": { "type": "string" }, "client_payload": { "type": ["object", "null"], "additionalProperties": true, "description": "The `client_payload` that was specified in the `POST /repos/{owner}/{repo}/dispatches` request 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" } }, "required": [ "action", "branch", "client_payload", "repository", "sender", "installation" ] }, "webhook-repository-edited": { "title": "repository edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "changes": { "type": "object", "properties": { "default_branch": { "type": "object", "properties": { "from": { "type": "string" } }, "required": ["from"] }, "description": { "type": "object", "properties": { "from": { "type": ["string", "null"] } }, "required": ["from"] }, "homepage": { "type": "object", "properties": { "from": { "type": ["string", "null"] } }, "required": ["from"] }, "topics": { "type": "object", "properties": { "from": { "type": ["array", "null"], "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" } }, "required": ["action", "changes", "repository", "sender"] }, "webhook-repository-import": { "title": "repository_import 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" }, "status": { "type": "string", "enum": ["success", "cancelled", "failure"] } }, "required": ["status", "repository", "sender"] }, "webhook-repository-privatized": { "title": "repository privatized event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-repository-publicized": { "title": "repository publicized event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-repository-renamed": { "title": "repository renamed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "changes", "repository", "sender"] }, "webhook-repository-ruleset-created": { "title": "repository ruleset created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "repository_ruleset": { "$ref": "#/components/schemas/repository-ruleset" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "repository_ruleset", "sender"] }, "repository-ruleset": { "title": "Repository ruleset", "type": "object", "description": "A set of rules to apply when specified conditions are met.", "required": ["id", "name", "source", "enforcement"], "properties": { "id": { "type": "integer", "description": "The ID of the ruleset" }, "name": { "type": "string", "description": "The name of the ruleset" }, "target": { "type": "string", "description": "The target of the ruleset", "enum": ["branch", "tag", "push", "repository"] }, "source_type": { "type": "string", "description": "The type of the source of the ruleset", "enum": ["Repository", "Organization", "Enterprise"] }, "source": { "type": "string", "description": "The name of the source" }, "enforcement": { "$ref": "#/components/schemas/repository-rule-enforcement" }, "bypass_actors": { "type": "array", "description": "The actors that can bypass the rules in this ruleset", "items": { "$ref": "#/components/schemas/repository-ruleset-bypass-actor" } }, "current_user_can_bypass": { "type": "string", "description": "The bypass type of the user making the API request for this ruleset. This field is only returned when\nquerying the repository-level endpoint.", "enum": ["always", "pull_requests_only", "never", "exempt"] }, "node_id": { "type": "string" }, "_links": { "type": "object", "properties": { "self": { "type": "object", "properties": { "href": { "type": "string", "description": "The URL of the ruleset" } } }, "html": { "type": ["object", "null"], "properties": { "href": { "type": "string", "description": "The html URL of the ruleset" } } } } }, "conditions": { "anyOf": [ { "$ref": "#/components/schemas/repository-ruleset-conditions" }, { "$ref": "#/components/schemas/org-ruleset-conditions" } ], "type": ["null", "object"] }, "rules": { "type": "array", "items": { "$ref": "#/components/schemas/repository-rule" } }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } }, "repository-rule-enforcement": { "type": "string", "description": "The enforcement level of the ruleset. `evaluate` allows admins to test rules before enforcing them. Admins can view insights on the Rule Insights page. `evaluate` is not available for the `repository` target.", "enum": ["disabled", "active", "evaluate"] }, "repository-ruleset-bypass-actor": { "title": "Repository Ruleset Bypass Actor", "type": "object", "description": "An actor that can bypass rules in a ruleset", "required": ["actor_type"], "properties": { "actor_id": { "type": ["integer", "null"], "description": "The ID of the actor that can bypass a ruleset. Required for `Integration`, `RepositoryRole`, `Team`, and `User` actor types. If `actor_type` is `OrganizationAdmin`, `actor_id` is ignored. If `actor_type` is `DeployKey`, this should be null. If `actor_type` is `EnterpriseOwner`, `actor_id` is ignored. `OrganizationAdmin`, `EnterpriseOwner` and `EnterpriseRole` are not applicable for personal repositories." }, "actor_type": { "type": "string", "enum": [ "Integration", "OrganizationAdmin", "RepositoryRole", "Team", "DeployKey", "EnterpriseOwner", "EnterpriseRole", "User" ], "description": "The type of actor that can bypass a ruleset" }, "bypass_mode": { "type": "string", "description": "When the specified actor can bypass the ruleset. `pull_request` means that an actor can only bypass rules on pull requests. `pull_request` is not applicable for the `DeployKey` actor type. Also, `pull_request` is only applicable to branch rulesets. When `bypass_mode` is `exempt`, rules will not be run for that actor and a bypass audit entry will not be created.", "enum": ["always", "pull_request", "exempt"], "default": "always" } } }, "repository-ruleset-conditions": { "title": "Repository ruleset conditions for ref names", "type": "object", "description": "Parameters for a repository ruleset ref name condition", "properties": { "ref_name": { "type": "object", "properties": { "include": { "type": "array", "description": "Array of ref names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~DEFAULT_BRANCH` to include the default branch or `~ALL` to include all branches.", "items": { "type": "string" } }, "exclude": { "type": "array", "description": "Array of ref names or patterns to exclude. The condition will not pass if any of these patterns match.", "items": { "type": "string" } } } } } }, "org-ruleset-conditions": { "title": "Organization ruleset conditions", "type": "object", "description": "Conditions for an organization ruleset.\nThe branch and tag rulesets conditions object should contain both `repository_name` and `ref_name` properties, or both `repository_id` and `ref_name` properties, or both `repository_property` and `ref_name` properties.\nThe push rulesets conditions object does not require the `ref_name` property.\nFor repository policy rulesets, the conditions object should only contain the `repository_name`, the `repository_id`, or the `repository_property`.", "oneOf": [ { "type": "object", "title": "repository_name_and_ref_name", "description": "Conditions to target repositories by name and refs by name", "allOf": [ { "$ref": "#/components/schemas/repository-ruleset-conditions" }, { "$ref": "#/components/schemas/repository-ruleset-conditions-repository-name-target" } ] }, { "type": "object", "title": "repository_id_and_ref_name", "description": "Conditions to target repositories by id and refs by name", "allOf": [ { "$ref": "#/components/schemas/repository-ruleset-conditions" }, { "$ref": "#/components/schemas/repository-ruleset-conditions-repository-id-target" } ] }, { "type": "object", "title": "repository_property_and_ref_name", "description": "Conditions to target repositories by property and refs by name", "allOf": [ { "$ref": "#/components/schemas/repository-ruleset-conditions" }, { "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-target" } ] } ] }, "repository-ruleset-conditions-repository-name-target": { "title": "Repository ruleset conditions for repository names", "type": "object", "description": "Parameters for a repository name condition", "properties": { "repository_name": { "type": "object", "properties": { "include": { "type": "array", "description": "Array of repository names or patterns to include. One of these patterns must match for the condition to pass. Also accepts `~ALL` to include all repositories.", "items": { "type": "string" } }, "exclude": { "type": "array", "description": "Array of repository names or patterns to exclude. The condition will not pass if any of these patterns match.", "items": { "type": "string" } }, "protected": { "type": "boolean", "description": "Whether renaming of target repositories is prevented." } } } }, "required": ["repository_name"] }, "repository-ruleset-conditions-repository-id-target": { "title": "Repository ruleset conditions for repository IDs", "type": "object", "description": "Parameters for a repository ID condition", "properties": { "repository_id": { "type": "object", "properties": { "repository_ids": { "type": "array", "description": "The repository IDs that the ruleset applies to. One of these IDs must match for the condition to pass.", "items": { "type": "integer" } } } } }, "required": ["repository_id"] }, "repository-ruleset-conditions-repository-property-target": { "title": "Repository ruleset conditions for repository properties", "type": "object", "description": "Parameters for a repository property condition", "properties": { "repository_property": { "type": "object", "properties": { "include": { "type": "array", "description": "The repository properties and values to include. All of these properties must match for the condition to pass.", "items": { "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" } }, "exclude": { "type": "array", "description": "The repository properties and values to exclude. The condition will not pass if any of these properties match.", "items": { "$ref": "#/components/schemas/repository-ruleset-conditions-repository-property-spec" } } } } }, "required": ["repository_property"] }, "repository-ruleset-conditions-repository-property-spec": { "title": "Repository ruleset property targeting definition", "type": "object", "description": "Parameters for a targeting a repository property", "properties": { "name": { "type": "string", "description": "The name of the repository property to target" }, "property_values": { "type": "array", "description": "The values to match for the repository property", "items": { "type": "string" } }, "source": { "type": "string", "description": "The source of the repository property. Defaults to 'custom' if not specified.", "enum": ["custom", "system"] } }, "required": ["name", "property_values"] }, "repository-rule": { "title": "Repository Rule", "type": "object", "description": "A repository rule.", "oneOf": [ { "$ref": "#/components/schemas/repository-rule-creation" }, { "$ref": "#/components/schemas/repository-rule-update" }, { "$ref": "#/components/schemas/repository-rule-deletion" }, { "$ref": "#/components/schemas/repository-rule-required-linear-history" }, { "$ref": "#/components/schemas/repository-rule-merge-queue" }, { "$ref": "#/components/schemas/repository-rule-required-deployments" }, { "$ref": "#/components/schemas/repository-rule-required-signatures" }, { "$ref": "#/components/schemas/repository-rule-pull-request" }, { "$ref": "#/components/schemas/repository-rule-required-status-checks" }, { "$ref": "#/components/schemas/repository-rule-non-fast-forward" }, { "$ref": "#/components/schemas/repository-rule-commit-message-pattern" }, { "$ref": "#/components/schemas/repository-rule-commit-author-email-pattern" }, { "$ref": "#/components/schemas/repository-rule-committer-email-pattern" }, { "$ref": "#/components/schemas/repository-rule-branch-name-pattern" }, { "$ref": "#/components/schemas/repository-rule-tag-name-pattern" }, { "$ref": "#/components/schemas/repository-rule-workflows" }, { "$ref": "#/components/schemas/repository-rule-code-scanning" }, { "$ref": "#/components/schemas/repository-rule-code-quality" }, { "$ref": "#/components/schemas/repository-rule-code-coverage" }, { "$ref": "#/components/schemas/repository-rule-copilot-code-review" }, { "$ref": "#/components/schemas/repository-rule-license-compliance-scanning" }, { "$ref": "#/components/schemas/repository-rule-file-path-restriction" }, { "$ref": "#/components/schemas/repository-rule-max-file-path-length" }, { "$ref": "#/components/schemas/repository-rule-file-extension-restriction" }, { "$ref": "#/components/schemas/repository-rule-max-file-size" } ] }, "repository-rule-creation": { "title": "creation", "description": "Only allow users with bypass permission to create matching refs.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["creation"] } } }, "repository-rule-update": { "title": "update", "description": "Only allow users with bypass permission to update matching refs.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["update"] }, "parameters": { "type": "object", "properties": { "update_allows_fetch_and_merge": { "type": "boolean", "description": "Branch can pull changes from its upstream repository" } }, "required": ["update_allows_fetch_and_merge"] } } }, "repository-rule-deletion": { "title": "deletion", "description": "Only allow users with bypass permissions to delete matching refs.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["deletion"] } } }, "repository-rule-required-linear-history": { "title": "required_linear_history", "description": "Prevent merge commits from being pushed to matching refs.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["required_linear_history"] } } }, "repository-rule-merge-queue": { "title": "merge_queue", "description": "Merges must be performed via a merge queue.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["merge_queue"] }, "parameters": { "type": "object", "properties": { "check_response_timeout_minutes": { "type": "integer", "description": "Maximum time for a required status check to report a conclusion. After this much time has elapsed, checks that have not reported a conclusion will be assumed to have failed", "minimum": 1, "maximum": 360 }, "grouping_strategy": { "type": "string", "description": "When set to ALLGREEN, the merge commit created by merge queue for each PR in the group must pass all required checks to merge. When set to HEADGREEN, only the commit at the head of the merge group, i.e. the commit containing changes from all of the PRs in the group, must pass its required checks to merge.", "enum": ["ALLGREEN", "HEADGREEN"] }, "max_entries_to_build": { "type": "integer", "description": "Limit the number of queued pull requests requesting checks and workflow runs at the same time.", "minimum": 0, "maximum": 100 }, "max_entries_to_merge": { "type": "integer", "description": "The maximum number of PRs that will be merged together in a group.", "minimum": 0, "maximum": 100 }, "merge_method": { "type": "string", "description": "Method to use when merging changes from queued pull requests.", "enum": ["MERGE", "SQUASH", "REBASE"] }, "min_entries_to_merge": { "type": "integer", "description": "The minimum number of PRs that will be merged together in a group.", "minimum": 0, "maximum": 100 }, "min_entries_to_merge_wait_minutes": { "type": "integer", "description": "The time merge queue should wait after the first PR is added to the queue for the minimum group size to be met. After this time has elapsed, the minimum group size will be ignored and a smaller group will be merged.", "minimum": 0, "maximum": 360 } }, "required": [ "check_response_timeout_minutes", "grouping_strategy", "max_entries_to_build", "max_entries_to_merge", "merge_method", "min_entries_to_merge", "min_entries_to_merge_wait_minutes" ] } } }, "repository-rule-required-deployments": { "title": "required_deployments", "description": "Choose which environments must be successfully deployed to before refs can be pushed into a ref that matches this rule.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["required_deployments"] }, "parameters": { "type": "object", "properties": { "required_deployment_environments": { "type": "array", "description": "The environments that must be successfully deployed to before branches can be merged.", "items": { "type": "string" } } }, "required": ["required_deployment_environments"] } } }, "repository-rule-required-signatures": { "title": "required_signatures", "description": "Commits pushed to matching refs must have verified signatures.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["required_signatures"] } } }, "repository-rule-pull-request": { "title": "pull_request", "description": "Require all commits be made to a non-target branch and submitted via a pull request before they can be merged.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["pull_request"] }, "parameters": { "type": "object", "properties": { "allowed_merge_methods": { "type": "array", "description": "Array of allowed merge methods. Allowed values include `merge`, `squash`, and `rebase`. At least one option must be enabled.", "items": { "type": "string", "enum": ["merge", "squash", "rebase"] } }, "dismiss_stale_reviews_on_push": { "type": "boolean", "description": "New, reviewable commits pushed will dismiss previous pull request review approvals." }, "dismissal_restriction": { "$ref": "#/components/schemas/repository-rule-params-dismissal-restriction" }, "require_code_owner_review": { "type": "boolean", "description": "Require an approving review in pull requests that modify files that have a designated code owner." }, "require_last_push_approval": { "type": "boolean", "description": "Whether the most recent reviewable push must be approved by someone other than the person who pushed it." }, "required_approving_review_count": { "type": "integer", "description": "The number of approving reviews that are required before a pull request can be merged.", "minimum": 0, "maximum": 10 }, "required_review_thread_resolution": { "type": "boolean", "description": "All conversations on code must be resolved before a pull request can be merged." }, "required_reviewers": { "type": "array", "description": "> [!NOTE]\n> `required_reviewers` is in beta and subject to change.\n\nA collection of reviewers and associated file patterns. Each reviewer has a list of file patterns which determine the files that reviewer is required to review.", "items": { "$ref": "#/components/schemas/repository-rule-params-required-reviewer-configuration" } } }, "required": [ "dismiss_stale_reviews_on_push", "require_code_owner_review", "require_last_push_approval", "required_approving_review_count", "required_review_thread_resolution" ] } } }, "repository-rule-params-dismissal-restriction": { "title": "DismissalRestriction", "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", "type": "object", "properties": { "allowed_actors": { "type": "array", "description": "Specify people, teams, or apps allowed to dismiss pull request reviews.", "items": { "$ref": "#/components/schemas/repository-rule-params-actor" } }, "enabled": { "type": "boolean", "description": "Whether to restrict review dismissal to specific actors." } }, "required": ["enabled"] }, "repository-rule-params-actor": { "title": "Actor", "description": "An actor allowed to dismiss pull request reviews", "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the actor that can dismiss reviews." }, "type": { "type": "string", "description": "The type of the actor", "enum": [ "User", "Team", "IntegrationInstallation", "RepositoryRole" ] } }, "required": ["id", "type"] }, "repository-rule-params-required-reviewer-configuration": { "title": "RequiredReviewerConfiguration", "description": "A reviewing team, and file patterns describing which files they must approve changes to.", "type": "object", "properties": { "file_patterns": { "type": "array", "description": "Array of file patterns. Pull requests which change matching files must be approved by the specified team. File patterns use fnmatch syntax.", "items": { "type": "string" } }, "minimum_approvals": { "type": "integer", "description": "Minimum number of approvals required from the specified team. If set to zero, the team will be added to the pull request but approval is optional." }, "reviewer": { "$ref": "#/components/schemas/repository-rule-params-reviewer" } }, "required": ["file_patterns", "minimum_approvals", "reviewer"] }, "repository-rule-params-reviewer": { "title": "Reviewer", "description": "A required reviewing team", "type": "object", "properties": { "id": { "type": "integer", "description": "ID of the reviewer which must review changes to matching files." }, "type": { "type": "string", "description": "The type of the reviewer", "enum": ["Team"] } }, "required": ["id", "type"] }, "repository-rule-required-status-checks": { "title": "required_status_checks", "description": "Choose which status checks must pass before the ref is updated. When enabled, commits must first be pushed to another ref where the checks pass.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["required_status_checks"] }, "parameters": { "type": "object", "properties": { "do_not_enforce_on_create": { "type": "boolean", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, "required_status_checks": { "type": "array", "description": "Status checks that are required.", "items": { "$ref": "#/components/schemas/repository-rule-params-status-check-configuration" } }, "strict_required_status_checks_policy": { "type": "boolean", "description": "Whether pull requests targeting a matching branch must be tested with the latest code. This setting will not take effect unless at least one status check is enabled." } }, "required": [ "required_status_checks", "strict_required_status_checks_policy" ] } } }, "repository-rule-params-status-check-configuration": { "title": "StatusCheckConfiguration", "description": "Required status check", "type": "object", "properties": { "context": { "type": "string", "description": "The status check context name that must be present on the commit." }, "integration_id": { "type": "integer", "description": "The optional integration ID that this status check must originate from." } }, "required": ["context"] }, "repository-rule-non-fast-forward": { "title": "non_fast_forward", "description": "Prevent users with push access from force pushing to refs.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["non_fast_forward"] } } }, "repository-rule-commit-message-pattern": { "title": "commit_message_pattern", "description": "Parameters to be used for the commit_message_pattern rule", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["commit_message_pattern"] }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", "description": "If true, the rule will fail if the pattern matches." }, "operator": { "type": "string", "description": "The operator to use for matching.", "enum": ["starts_with", "ends_with", "contains", "regex"] }, "pattern": { "type": "string", "description": "The pattern to match with." } }, "required": ["operator", "pattern"] } } }, "repository-rule-commit-author-email-pattern": { "title": "commit_author_email_pattern", "description": "Parameters to be used for the commit_author_email_pattern rule", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["commit_author_email_pattern"] }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", "description": "If true, the rule will fail if the pattern matches." }, "operator": { "type": "string", "description": "The operator to use for matching.", "enum": ["starts_with", "ends_with", "contains", "regex"] }, "pattern": { "type": "string", "description": "The pattern to match with." } }, "required": ["operator", "pattern"] } } }, "repository-rule-committer-email-pattern": { "title": "committer_email_pattern", "description": "Parameters to be used for the committer_email_pattern rule", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["committer_email_pattern"] }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", "description": "If true, the rule will fail if the pattern matches." }, "operator": { "type": "string", "description": "The operator to use for matching.", "enum": ["starts_with", "ends_with", "contains", "regex"] }, "pattern": { "type": "string", "description": "The pattern to match with." } }, "required": ["operator", "pattern"] } } }, "repository-rule-branch-name-pattern": { "title": "branch_name_pattern", "description": "Parameters to be used for the branch_name_pattern rule", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["branch_name_pattern"] }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", "description": "If true, the rule will fail if the pattern matches." }, "operator": { "type": "string", "description": "The operator to use for matching.", "enum": ["starts_with", "ends_with", "contains", "regex"] }, "pattern": { "type": "string", "description": "The pattern to match with." } }, "required": ["operator", "pattern"] } } }, "repository-rule-tag-name-pattern": { "title": "tag_name_pattern", "description": "Parameters to be used for the tag_name_pattern rule", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["tag_name_pattern"] }, "parameters": { "type": "object", "properties": { "name": { "type": "string", "description": "How this rule appears when configuring it." }, "negate": { "type": "boolean", "description": "If true, the rule will fail if the pattern matches." }, "operator": { "type": "string", "description": "The operator to use for matching.", "enum": ["starts_with", "ends_with", "contains", "regex"] }, "pattern": { "type": "string", "description": "The pattern to match with." } }, "required": ["operator", "pattern"] } } }, "repository-rule-workflows": { "title": "workflows", "description": "Require all changes made to a targeted branch to pass the specified workflows before they can be merged.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["workflows"] }, "parameters": { "type": "object", "properties": { "do_not_enforce_on_create": { "type": "boolean", "description": "Allow repositories and branches to be created if a check would otherwise prohibit it." }, "workflows": { "type": "array", "description": "Workflows that must pass for this rule to pass.", "items": { "$ref": "#/components/schemas/repository-rule-params-workflow-file-reference" } } }, "required": ["workflows"] } } }, "repository-rule-params-workflow-file-reference": { "title": "WorkflowFileReference", "description": "A workflow that must run for this rule to pass", "type": "object", "properties": { "path": { "type": "string", "description": "The path to the workflow file" }, "ref": { "type": "string", "description": "The ref (branch or tag) of the workflow file to use" }, "repository_id": { "type": "integer", "description": "The ID of the repository where the workflow is defined" }, "sha": { "type": "string", "description": "The commit SHA of the workflow file to use" } }, "required": ["path", "repository_id"] }, "repository-rule-code-scanning": { "title": "code_scanning", "description": "Choose which tools must provide code scanning results before the reference is updated. When configured, code scanning must be enabled and have results for both the commit and the reference being updated.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["code_scanning"] }, "parameters": { "type": "object", "properties": { "code_scanning_tools": { "type": "array", "description": "Tools that must provide code scanning results for this rule to pass.", "items": { "$ref": "#/components/schemas/repository-rule-params-code-scanning-tool" } } }, "required": ["code_scanning_tools"] } } }, "repository-rule-params-code-scanning-tool": { "title": "CodeScanningTool", "description": "A tool that must provide code scanning results for this rule to pass.", "type": "object", "properties": { "alerts_threshold": { "type": "string", "description": "The severity level at which code scanning results that raise alerts block a reference update. For more information on alert severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": ["none", "errors", "errors_and_warnings", "all"] }, "security_alerts_threshold": { "type": "string", "description": "The severity level at which code scanning results that raise security alerts block a reference update. For more information on security severity levels, see \"[About code scanning alerts](https://docs.github.com/enterprise-cloud@latest/code-security/code-scanning/managing-code-scanning-alerts/about-code-scanning-alerts#about-alert-severity-and-security-severity-levels).\"", "enum": [ "none", "critical", "high_or_higher", "medium_or_higher", "all" ] }, "tool": { "type": "string", "description": "The name of a code scanning tool" } }, "required": ["alerts_threshold", "security_alerts_threshold", "tool"] }, "repository-rule-code-quality": { "title": "code_quality", "description": "Choose which severity levels of code quality results should block pull request merges. When configured, a code quality analysis must be done on the pull request before the changes can be merged.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["code_quality"] }, "parameters": { "type": "object", "properties": { "severity": { "type": "string", "description": "The lowest severity level at which code quality reviews need to be resolved before commits can be merged.", "enum": ["errors", "warnings", "notes", "all"] } }, "required": ["severity"] } } }, "repository-rule-code-coverage": { "title": "code_coverage", "description": "Enforce minimum line coverage thresholds on pull requests. When configured, uploaded coverage data must meet the specified criteria before changes can be merged.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["code_coverage"] }, "parameters": { "type": "object", "properties": { "max_coverage_drop": { "type": "number", "format": "float", "description": "The maximum percentage points that line coverage may drop relative to the default branch. Pull requests that reduce line coverage by more than this amount will be blocked.", "minimum": 0, "maximum": 100 }, "minimum_coverage": { "type": "number", "format": "float", "description": "The absolute minimum line coverage percentage required. Pull requests with line coverage below this threshold will be blocked.", "minimum": 0, "maximum": 100 } } } } }, "repository-rule-copilot-code-review": { "title": "copilot_code_review", "description": "Request Copilot code review for new pull requests automatically if the author has access to Copilot code review and their premium requests quota has not reached the limit.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["copilot_code_review"] }, "parameters": { "type": "object", "properties": { "review_draft_pull_requests": { "type": "boolean", "description": "Copilot automatically reviews draft pull requests before they are marked as ready for review." }, "review_on_push": { "type": "boolean", "description": "Copilot automatically reviews each new push to the pull request." } } } } }, "repository-rule-license-compliance-scanning": { "title": "license_compliance_scanning", "description": "Enforce any added or changed dependencies to comply with the organization's license policy.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["license_compliance_scanning"] } } }, "repository-rule-file-path-restriction": { "title": "file_path_restriction", "description": "Prevent commits that include changes in specified file and folder paths from being pushed to the commit graph. This includes absolute paths that contain file names.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["file_path_restriction"] }, "parameters": { "type": "object", "properties": { "restricted_file_paths": { "type": "array", "description": "The file paths that are restricted from being pushed to the commit graph.", "items": { "type": "string" } } }, "required": ["restricted_file_paths"] } } }, "repository-rule-max-file-path-length": { "title": "max_file_path_length", "description": "Prevent commits that include file paths that exceed the specified character limit from being pushed to the commit graph.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["max_file_path_length"] }, "parameters": { "type": "object", "properties": { "max_file_path_length": { "type": "integer", "description": "The maximum amount of characters allowed in file paths.", "minimum": 1, "maximum": 32767 } }, "required": ["max_file_path_length"] } } }, "repository-rule-file-extension-restriction": { "title": "file_extension_restriction", "description": "Prevent commits that include files with specified file extensions from being pushed to the commit graph.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["file_extension_restriction"] }, "parameters": { "type": "object", "properties": { "restricted_file_extensions": { "type": "array", "description": "The file extensions that are restricted from being pushed to the commit graph.", "items": { "type": "string" } } }, "required": ["restricted_file_extensions"] } } }, "repository-rule-max-file-size": { "title": "max_file_size", "description": "Prevent commits with individual files that exceed the specified limit from being pushed to the commit graph.", "type": "object", "required": ["type"], "properties": { "type": { "type": "string", "enum": ["max_file_size"] }, "parameters": { "type": "object", "properties": { "max_file_size": { "type": "integer", "description": "The maximum file size allowed in megabytes. This limit does not apply to Git Large File Storage (Git LFS).", "minimum": 1, "maximum": 100 } }, "required": ["max_file_size"] } } }, "webhook-repository-ruleset-deleted": { "title": "repository ruleset deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "repository_ruleset": { "$ref": "#/components/schemas/repository-ruleset" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "repository_ruleset", "sender"] }, "webhook-repository-ruleset-edited": { "title": "repository ruleset edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["edited"] }, "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" }, "repository_ruleset": { "$ref": "#/components/schemas/repository-ruleset" }, "changes": { "type": "object", "properties": { "name": { "type": "object", "properties": { "from": { "type": "string" } } }, "enforcement": { "type": "object", "properties": { "from": { "type": "string" } } }, "conditions": { "type": "object", "properties": { "added": { "type": "array", "items": { "$ref": "#/components/schemas/repository-ruleset-conditions" } }, "deleted": { "type": "array", "items": { "$ref": "#/components/schemas/repository-ruleset-conditions" } }, "updated": { "type": "array", "items": { "type": "object", "properties": { "condition": { "$ref": "#/components/schemas/repository-ruleset-conditions" }, "changes": { "type": "object", "properties": { "condition_type": { "type": "object", "properties": { "from": { "type": "string" } } }, "target": { "type": "object", "properties": { "from": { "type": "string" } } }, "include": { "type": "object", "properties": { "from": { "type": "array", "items": { "type": "string" } } } }, "exclude": { "type": "object", "properties": { "from": { "type": "array", "items": { "type": "string" } } } } } } } } } } }, "rules": { "type": "object", "properties": { "added": { "type": "array", "items": { "$ref": "#/components/schemas/repository-rule" } }, "deleted": { "type": "array", "items": { "$ref": "#/components/schemas/repository-rule" } }, "updated": { "type": "array", "items": { "type": "object", "properties": { "rule": { "$ref": "#/components/schemas/repository-rule" }, "changes": { "type": "object", "properties": { "configuration": { "type": "object", "properties": { "from": { "type": "string" } } }, "rule_type": { "type": "object", "properties": { "from": { "type": "string" } } }, "pattern": { "type": "object", "properties": { "from": { "type": "string" } } } } } } } } } } } }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "repository_ruleset", "sender"] }, "webhook-repository-transferred": { "title": "repository transferred event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer", "format": "int64" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" } }, "required": ["action", "changes", "repository", "sender"] }, "webhook-repository-unarchived": { "title": "repository unarchived event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-repository-vulnerability-alert-create": { "title": "repository_vulnerability_alert create event", "type": "object", "properties": { "action": { "type": "string", "enum": ["create"] }, "alert": { "$ref": "#/components/schemas/webhooks_alert" }, "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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhooks_alert": { "title": "Repository Vulnerability Alert Alert", "description": "The security alert of the vulnerable dependency.", "type": "object", "required": [ "affected_package_name", "affected_range", "created_at", "external_identifier", "external_reference", "ghsa_id", "id", "node_id", "number", "severity", "state" ], "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "external_identifier": { "type": "string" }, "external_reference": { "type": ["string", "null"], "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": ["auto_dismissed", "open"] } } }, "webhook-repository-vulnerability-alert-dismiss": { "title": "repository_vulnerability_alert dismiss event", "type": "object", "properties": { "action": { "type": "string", "enum": ["dismiss"] }, "alert": { "title": "Repository Vulnerability Alert Alert", "description": "The security alert of the vulnerable dependency.", "type": "object", "required": [ "affected_package_name", "affected_range", "created_at", "dismiss_reason", "dismissed_at", "dismisser", "external_identifier", "external_reference", "ghsa_id", "id", "node_id", "number", "severity", "state" ], "properties": { "affected_package_name": { "type": "string" }, "affected_range": { "type": "string" }, "created_at": { "type": "string" }, "dismiss_comment": { "type": ["string", "null"] }, "dismiss_reason": { "type": "string" }, "dismissed_at": { "type": "string" }, "dismisser": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "external_identifier": { "type": "string" }, "external_reference": { "type": ["string", "null"], "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": ["dismissed"] } } }, "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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-repository-vulnerability-alert-reopen": { "title": "repository_vulnerability_alert reopen event", "type": "object", "properties": { "action": { "type": "string", "enum": ["reopen"] }, "alert": { "$ref": "#/components/schemas/webhooks_alert" }, "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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-repository-vulnerability-alert-resolve": { "title": "repository_vulnerability_alert resolve event", "type": "object", "properties": { "action": { "type": "string", "enum": ["resolve"] }, "alert": { "title": "Repository Vulnerability Alert Alert", "description": "The security alert of the vulnerable dependency.", "type": "object", "required": [ "affected_package_name", "affected_range", "created_at", "external_identifier", "external_reference", "ghsa_id", "id", "node_id", "number", "severity", "state" ], "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "external_identifier": { "type": "string" }, "external_reference": { "type": ["string", "null"], "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": ["fixed", "open"] } } }, "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" } }, "required": ["action", "alert", "repository", "sender"] }, "webhook-secret-scanning-alert-assigned": { "title": "secret_scanning_alert assigned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["assigned"] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, "assignee": { "$ref": "#/components/schemas/simple-user" }, "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" } }, "required": ["action", "alert", "repository"] }, "secret-scanning-alert-webhook": { "type": "object", "properties": { "number": { "$ref": "#/components/schemas/alert-number" }, "created_at": { "$ref": "#/components/schemas/alert-created-at" }, "updated_at": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/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." }, "resolution": { "$ref": "#/components/schemas/secret-scanning-alert-resolution-webhook" }, "resolved_at": { "type": ["string", "null"], "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "resolved_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "resolution_comment": { "type": ["string", "null"], "description": "An optional comment to resolve an alert." }, "secret_type": { "type": "string", "description": "The type of secret that secret scanning detected." }, "secret_type_display_name": { "type": "string", "description": "User-friendly name for the detected secret, matching the `secret_type`.\nFor a list of built-in patterns, see \"[Supported secret scanning patterns](https://docs.github.com/enterprise-cloud@latest/code-security/secret-scanning/introduction/supported-secret-scanning-patterns#supported-secrets).\"" }, "provider": { "type": ["string", "null"], "description": "The provider of the secret that was detected." }, "provider_slug": { "type": ["string", "null"], "description": "The slug identifier for the provider of the secret that was detected." }, "secret_category": { "type": "string", "description": "The category of the detected secret. `default` covers specific provider patterns and custom patterns; `generic` covers non-specific patterns and AI-detected secrets.", "enum": ["default", "generic"] }, "validity": { "type": "string", "description": "The token status as of the latest validity check.", "enum": ["active", "inactive", "unknown"] }, "push_protection_bypassed": { "type": ["boolean", "null"], "description": "Whether push protection was bypassed for the detected secret." }, "push_protection_bypassed_by": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "push_protection_bypassed_at": { "type": ["string", "null"], "format": "date-time", "description": "The time that push protection was bypassed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "push_protection_bypass_request_reviewer": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "push_protection_bypass_request_reviewer_comment": { "type": ["string", "null"], "description": "An optional comment when reviewing a push protection bypass." }, "push_protection_bypass_request_comment": { "type": ["string", "null"], "description": "An optional comment when requesting a push protection bypass." }, "push_protection_bypass_request_html_url": { "type": ["string", "null"], "format": "uri", "description": "The URL to a push protection bypass request." }, "publicly_leaked": { "type": ["boolean", "null"], "description": "Whether the detected secret was publicly leaked." }, "multi_repo": { "type": ["boolean", "null"], "description": "Whether the detected secret was found in multiple repositories in the same organization or business." }, "assigned_to": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "closure_request_comment": { "type": ["string", "null"], "description": "An optional comment from the closure request author." }, "closure_request_reviewer_comment": { "type": ["string", "null"], "description": "An optional comment from the closure request reviewer." }, "closure_request_reviewer": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/simple-user" } ] }, "metadata": { "$ref": "#/components/schemas/secret-scanning-alert-metadata" } } }, "secret-scanning-alert-resolution-webhook": { "type": ["string", "null"], "description": "The reason for resolving the alert.", "enum": [ "false_positive", "wont_fix", "revoked", "used_in_tests", "pattern_deleted", "pattern_edited", null ] }, "secret-scanning-alert-metadata": { "type": "array", "description": "A list of metadata key/value pairs associated with the secret scanning alert.", "readOnly": true, "items": { "type": "object", "properties": { "key": { "type": "string", "description": "The metadata key." }, "value": { "type": "string", "description": "The metadata value." } }, "required": ["key", "value"] } }, "webhook-secret-scanning-alert-created": { "title": "secret_scanning_alert created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "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"] }, "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" } }, "required": ["location", "alert", "repository", "sender", "action"] }, "secret-scanning-location": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "commit", "wiki_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.", "examples": ["commit"] }, "details": { "oneOf": [ { "$ref": "#/components/schemas/secret-scanning-location-commit" }, { "$ref": "#/components/schemas/secret-scanning-location-wiki-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" } ] } } }, "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", "examples": ["/example/secrets.txt"] }, "start_line": { "type": "number", "description": "Line number at which the secret starts in the file" }, "end_line": { "type": "number", "description": "Line number at which the secret ends in the file" }, "start_column": { "type": "number", "description": "The column at which the secret starts within the start line when the file is interpreted as 8BIT ASCII" }, "end_column": { "type": "number", "description": "The column at which the secret ends within the end line when the file is interpreted as 8BIT ASCII" }, "blob_sha": { "type": "string", "description": "SHA-1 hash ID of the associated blob", "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] }, "blob_url": { "type": "string", "description": "The API URL to get the associated blob resource" }, "commit_sha": { "type": "string", "description": "SHA-1 hash ID of the associated commit", "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] }, "commit_url": { "type": "string", "description": "The API URL to get the associated commit resource" }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL to get the associated commit resource.", "examples": [ "https://github.com/octocat/Hello-World/blob/af5626b/example/secrets.txt#L1-L1" ] } }, "required": [ "path", "start_line", "end_line", "start_column", "end_column", "blob_sha", "blob_url", "commit_sha", "commit_url" ] }, "secret-scanning-location-wiki-commit": { "description": "Represents a 'wiki_commit' secret scanning location type. This location type shows that a secret was detected inside a commit to a repository wiki.", "type": "object", "properties": { "path": { "type": "string", "description": "The file path of the wiki page", "examples": ["/example/Home.md"] }, "start_line": { "type": "number", "description": "Line number at which the secret starts in the file" }, "end_line": { "type": "number", "description": "Line number at which the secret ends in the file" }, "start_column": { "type": "number", "description": "The column at which the secret starts within the start line when the file is interpreted as 8-bit ASCII." }, "end_column": { "type": "number", "description": "The column at which the secret ends within the end line when the file is interpreted as 8-bit ASCII." }, "blob_sha": { "type": "string", "description": "SHA-1 hash ID of the associated blob", "examples": ["af5626b4a114abcb82d63db7c8082c3c4756e51b"] }, "page_url": { "type": "string", "description": "The GitHub URL to get the associated wiki page", "examples": [ "https://github.com/octocat/Hello-World/wiki/Home/302c0b7e200761c9dd9b57e57db540ee0b4293a5" ] }, "commit_sha": { "type": "string", "description": "SHA-1 hash ID of the associated commit", "examples": ["302c0b7e200761c9dd9b57e57db540ee0b4293a5"] }, "commit_url": { "type": "string", "description": "The GitHub URL to get the associated wiki commit", "examples": [ "https://github.com/octocat/Hello-World/wiki/_compare/302c0b7e200761c9dd9b57e57db540ee0b4293a5" ] } }, "required": [ "path", "start_line", "end_line", "start_column", "end_column", "blob_sha", "page_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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the issue where the secret was detected.", "examples": ["https://github.com/octocat/Hello-World/issues/1"] } }, "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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/1347" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the issue where the secret was detected.", "examples": ["https://github.com/octocat/Hello-World/issues/1"] } }, "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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the issue comment where the secret was detected.", "examples": [ "https://github.com/octocat/Hello-World/issues/1#issuecomment-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.", "examples": [ "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.", "examples": [ "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.", "examples": [ "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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the pull request where the secret was detected.", "examples": ["https://github.com/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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the pull request where the secret was detected.", "examples": ["https://github.com/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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/issues/comments/1081119451" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the pull request comment where the secret was detected.", "examples": [ "https://github.com/octocat/Hello-World/pull/2846#issuecomment-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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/2846/reviews/80" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the pull request review where the secret was detected.", "examples": [ "https://github.com/octocat/Hello-World/pull/2846#pullrequestreview-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.", "examples": [ "https://api.github.com/repos/octocat/Hello-World/pulls/comments/12" ] }, "html_url": { "type": "string", "format": "uri", "description": "The GitHub URL for the pull request review comment where the secret was detected.", "examples": [ "https://github.com/octocat/Hello-World/pull/2846#discussion_r12" ] } }, "required": ["pull_request_review_comment_url"] }, "webhook-secret-scanning-alert-metadata-created": { "title": "secret_scanning_alert metadata created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["metadata_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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-alert-metadata-removed": { "title": "secret_scanning_alert metadata removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["metadata_removed"] }, "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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-alert-publicly-leaked": { "title": "secret_scanning_alert publicly leaked event", "type": "object", "properties": { "action": { "type": "string", "enum": ["publicly_leaked"] }, "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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-alert-reopened": { "title": "secret_scanning_alert reopened event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-alert-resolved": { "title": "secret_scanning_alert resolved event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-alert-unassigned": { "title": "secret_scanning_alert unassigned event", "type": "object", "properties": { "action": { "type": "string", "enum": ["unassigned"] }, "alert": { "$ref": "#/components/schemas/secret-scanning-alert-webhook" }, "assignee": { "$ref": "#/components/schemas/simple-user" }, "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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-alert-validated": { "title": "secret_scanning_alert validated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["validated"] }, "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" } }, "required": ["action", "alert", "repository"] }, "webhook-secret-scanning-scan-completed": { "title": "secret_scanning_scan completed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["completed"] }, "type": { "type": "string", "description": "What type of scan was completed", "enum": [ "backfill", "custom-pattern-backfill", "pattern-version-backfill" ] }, "source": { "type": "string", "description": "What type of content was scanned", "enum": ["git", "issues", "pull-requests", "discussions", "wiki"] }, "started_at": { "type": "string", "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "completed_at": { "type": "string", "format": "date-time", "description": "The time that the alert was resolved in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`." }, "secret_types": { "type": ["array", "null"], "description": "List of patterns that were updated. This will be empty for normal backfill scans or custom pattern updates", "items": { "type": "string" } }, "custom_pattern_name": { "type": ["string", "null"], "description": "If the scan was triggered by a custom pattern update, this will be the name of the pattern that was updated" }, "custom_pattern_scope": { "type": ["string", "null"], "description": "If the scan was triggered by a custom pattern update, this will be the scope of the pattern that was updated", "enum": ["repository", "organization", "enterprise", null] }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "source", "type", "started_at", "completed_at"] }, "webhook-security-advisory-published": { "title": "security_advisory published event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "security_advisory"] }, "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", "null"] } }, "required": ["vector_string", "score"] }, "cvss_severities": { "$ref": "#/components/schemas/cvss-severities" }, "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", "null"], "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", "null"] } }, "required": [ "cvss", "cwes", "ghsa_id", "summary", "description", "severity", "identifiers", "references", "published_at", "updated_at", "withdrawn_at", "vulnerabilities" ], "x-github-breaking-changes": [ { "changeset": "deprecate_cvss", "patch": { "properties": { "cvss": null }, "required": [ "cwes", "ghsa_id", "summary", "description", "severity", "identifiers", "references", "published_at", "updated_at", "withdrawn_at", "vulnerabilities" ] }, "version": "2026-03-10" } ] }, "webhook-security-advisory-updated": { "title": "security_advisory updated event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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": { "$ref": "#/components/schemas/webhooks_security_advisory" }, "sender": { "$ref": "#/components/schemas/simple-user" } }, "required": ["action", "security_advisory"] }, "webhook-security-advisory-withdrawn": { "title": "security_advisory withdrawn event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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", "null"] } }, "required": ["vector_string", "score"] }, "cvss_severities": { "$ref": "#/components/schemas/cvss-severities" }, "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", "null"], "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" } }, "required": ["action", "security_advisory"], "x-github-breaking-changes": [ { "changeset": "deprecate_cvss", "patch": [ { "op": "remove", "path": "/properties/security_advisory/properties/cvss" }, { "op": "remove", "path": "/properties/security_advisory/required/0" } ], "version": "2026-03-10" } ] }, "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" } }, "required": ["changes", "repository"] }, "full-repository": { "title": "Full Repository", "description": "Full Repository", "type": "object", "properties": { "id": { "type": "integer", "format": "int64", "examples": [1296269] }, "node_id": { "type": "string", "examples": ["MDEwOlJlcG9zaXRvcnkxMjk2MjY5"] }, "name": { "type": "string", "examples": ["Hello-World"] }, "full_name": { "type": "string", "examples": ["octocat/Hello-World"] }, "owner": { "$ref": "#/components/schemas/simple-user" }, "private": { "type": "boolean" }, "html_url": { "type": "string", "format": "uri", "examples": ["https://github.com/octocat/Hello-World"] }, "description": { "type": ["string", "null"], "examples": ["This your first repo!"] }, "fork": { "type": "boolean" }, "url": { "type": "string", "format": "uri", "examples": ["https://api.github.com/repos/octocat/Hello-World"] }, "archive_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" ] }, "assignees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" ] }, "blobs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" ] }, "branches_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" ] }, "collaborators_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" ] }, "comments_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/comments{/number}" ] }, "commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" ] }, "compare_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" ] }, "contents_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" ] }, "contributors_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/contributors" ] }, "deployments_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/deployments" ] }, "downloads_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/downloads" ] }, "events_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/events" ] }, "forks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/forks" ] }, "git_commits_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" ] }, "git_refs_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" ] }, "git_tags_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" ] }, "git_url": { "type": "string", "examples": ["git:github.com/octocat/Hello-World.git"] }, "issue_comment_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" ] }, "issue_events_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" ] }, "issues_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/issues{/number}" ] }, "keys_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" ] }, "labels_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/labels{/name}" ] }, "languages_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/languages" ] }, "merges_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/merges" ] }, "milestones_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" ] }, "notifications_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" ] }, "pulls_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" ] }, "releases_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/releases{/id}" ] }, "ssh_url": { "type": "string", "examples": ["git@github.com:octocat/Hello-World.git"] }, "stargazers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/stargazers" ] }, "statuses_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" ] }, "subscribers_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscribers" ] }, "subscription_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/subscription" ] }, "tags_url": { "type": "string", "format": "uri", "examples": ["http://api.github.com/repos/octocat/Hello-World/tags"] }, "teams_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/teams" ] }, "trees_url": { "type": "string", "examples": [ "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" ] }, "clone_url": { "type": "string", "examples": ["https://github.com/octocat/Hello-World.git"] }, "mirror_url": { "type": ["string", "null"], "format": "uri", "examples": ["git:git.example.com/octocat/Hello-World"] }, "hooks_url": { "type": "string", "format": "uri", "examples": [ "http://api.github.com/repos/octocat/Hello-World/hooks" ] }, "svn_url": { "type": "string", "format": "uri", "examples": ["https://svn.github.com/octocat/Hello-World"] }, "homepage": { "type": ["string", "null"], "format": "uri", "examples": ["https://github.com"] }, "language": { "type": ["string", "null"] }, "forks_count": { "type": "integer", "examples": [9] }, "stargazers_count": { "type": "integer", "examples": [80] }, "watchers_count": { "type": "integer", "examples": [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", "examples": [108] }, "default_branch": { "type": "string", "examples": ["master"] }, "open_issues_count": { "type": "integer", "examples": [0] }, "is_template": { "type": "boolean", "examples": [true] }, "topics": { "type": "array", "items": { "type": "string" }, "examples": ["octocat", "atom", "electron", "API"] }, "has_issues": { "type": "boolean", "examples": [true] }, "has_projects": { "type": "boolean", "examples": [true] }, "has_wiki": { "type": "boolean", "examples": [true] }, "has_pages": { "type": "boolean" }, "has_downloads": { "type": "boolean", "examples": [true] }, "has_discussions": { "type": "boolean", "examples": [true] }, "has_pull_requests": { "type": "boolean", "examples": [true] }, "pull_request_creation_policy": { "description": "The policy controlling who can create pull requests: all or collaborators_only.", "type": "string", "enum": ["all", "collaborators_only"], "examples": ["all"] }, "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", "examples": ["public"] }, "pushed_at": { "type": "string", "format": "date-time", "examples": ["2011-01-26T19:06:43Z"] }, "created_at": { "type": "string", "format": "date-time", "examples": ["2011-01-26T19:01:12Z"] }, "updated_at": { "type": "string", "format": "date-time", "examples": ["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", "examples": [true] }, "template_repository": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/repository" } ] }, "temp_clone_token": { "type": ["string", "null"] }, "allow_squash_merge": { "type": "boolean", "examples": [true] }, "allow_auto_merge": { "type": "boolean", "examples": [false] }, "delete_branch_on_merge": { "type": "boolean", "examples": [false] }, "allow_merge_commit": { "type": "boolean", "examples": [true] }, "allow_update_branch": { "type": "boolean", "examples": [true] }, "use_squash_pr_title_as_default": { "type": "boolean", "examples": [false] }, "squash_merge_commit_title": { "type": "string", "enum": ["PR_TITLE", "COMMIT_OR_PR_TITLE"], "description": "The default value for a squash merge commit title:\n\n- `PR_TITLE` - default to the pull request's title.\n- `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).", "examples": ["PR_TITLE"] }, "squash_merge_commit_message": { "type": "string", "enum": ["PR_BODY", "COMMIT_MESSAGES", "BLANK"], "description": "The default value for a squash merge commit message:\n\n- `PR_BODY` - default to the pull request's body.\n- `COMMIT_MESSAGES` - default to the branch's commit messages.\n- `BLANK` - default to a blank commit message.", "examples": ["PR_BODY"] }, "merge_commit_title": { "type": "string", "enum": ["PR_TITLE", "MERGE_MESSAGE"], "description": "The default value for a merge commit title.\n\n - `PR_TITLE` - default to the pull request's title.\n - `MERGE_MESSAGE` - default to the classic title for a merge message (e.g., Merge pull request #123 from branch-name).", "examples": ["PR_TITLE"] }, "merge_commit_message": { "type": "string", "enum": ["PR_BODY", "PR_TITLE", "BLANK"], "description": "The default value for a merge commit message.\n\n- `PR_TITLE` - default to the pull request's title.\n- `PR_BODY` - default to the pull request's body.\n- `BLANK` - default to a blank commit message.", "examples": ["PR_BODY"] }, "allow_forking": { "type": "boolean", "examples": [true] }, "web_commit_signoff_required": { "type": "boolean", "examples": [false] }, "subscribers_count": { "type": "integer", "examples": [42] }, "network_count": { "type": "integer", "examples": [0] }, "license": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/license-simple" } ] }, "organization": { "anyOf": [ { "type": "null" }, { "$ref": "#/components/schemas/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" }, "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 } }, "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" ], "x-github-breaking-changes": [ { "changeset": "remove_use_squash_pr_title_as_default", "patch": { "properties": { "use_squash_pr_title_as_default": null } }, "version": "2026-03-10" }, { "changeset": "remove_has_downloads", "patch": { "properties": { "has_downloads": null } }, "version": "2026-03-10" } ] }, "code-of-conduct-simple": { "title": "Code Of Conduct Simple", "description": "Code of Conduct Simple", "type": "object", "properties": { "url": { "type": "string", "format": "uri", "examples": [ "https://api.github.com/repos/github/docs/community/code_of_conduct" ] }, "key": { "type": "string", "examples": ["citizen_code_of_conduct"] }, "name": { "type": "string", "examples": ["Citizen Code of Conduct"] }, "html_url": { "type": ["string", "null"], "format": "uri", "examples": [ "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" ] } }, "required": ["url", "key", "name", "html_url"] }, "webhook-sponsorship-cancelled": { "title": "sponsorship cancelled event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" } }, "required": ["action", "sponsorship", "sender"] }, "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" }, "user_view_type": { "type": "string" } } }, "node_id": { "type": "string" }, "privacy_level": { "type": "string" }, "sponsor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "required": ["login", "id"] }, "sponsorable": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] }, "webhook-sponsorship-created": { "title": "sponsorship created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" } }, "required": ["action", "sponsorship", "sender"] }, "webhook-sponsorship-edited": { "title": "sponsorship edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" } }, "required": ["action", "changes", "sponsorship", "sender"] }, "webhook-sponsorship-pending-cancellation": { "title": "sponsorship pending_cancellation event", "type": "object", "properties": { "action": { "type": "string", "enum": ["pending_cancellation"] }, "effective_date": { "$ref": "#/components/schemas/webhooks_effective_date" }, "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" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" } }, "required": ["action", "sponsorship", "sender"] }, "webhooks_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" }, "webhook-sponsorship-pending-tier-change": { "title": "sponsorship pending_tier_change event", "type": "object", "properties": { "action": { "type": "string", "enum": ["pending_tier_change"] }, "changes": { "$ref": "#/components/schemas/webhooks_changes_8" }, "effective_date": { "$ref": "#/components/schemas/webhooks_effective_date" }, "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" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" } }, "required": ["action", "changes", "sponsorship", "sender"] }, "webhooks_changes_8": { "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"] }, "webhook-sponsorship-tier-changed": { "title": "sponsorship tier_changed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["tier_changed"] }, "changes": { "$ref": "#/components/schemas/webhooks_changes_8" }, "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" }, "sponsorship": { "$ref": "#/components/schemas/webhooks_sponsorship" } }, "required": ["action", "changes", "sponsorship", "sender"] }, "webhook-star-created": { "title": "star created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "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", "null"] } }, "required": ["action", "starred_at", "repository", "sender"] }, "webhook-star-deleted": { "title": "star deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "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": ["null"] } }, "required": ["action", "starred_at", "repository", "sender"] }, "webhook-status": { "title": "status event", "type": "object", "properties": { "avatar_url": { "type": ["string", "null"], "format": "uri" }, "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", "null"] }, "url": { "type": ["string", "null"], "format": "uri" } }, "required": ["sha", "url"] }, "name": { "type": "string" }, "protected": { "type": "boolean" } }, "required": ["name", "commit", "protected"] } }, "commit": { "type": "object", "properties": { "author": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_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", "null"], "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", "null"], "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", "null"] }, "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", "null"] }, "verified": { "type": "boolean" }, "verified_at": { "type": ["string", "null"] } }, "required": [ "verified", "reason", "signature", "payload", "verified_at" ] } }, "required": [ "author", "committer", "message", "tree", "url", "comment_count", "verification" ] }, "committer": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_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" }, "created_at": { "type": "string" }, "description": { "description": "The optional human-readable description added to the status.", "type": ["string", "null"] }, "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "id": { "description": "The unique identifier of the status.", "type": "integer" }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "name": { "type": "string" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "sha": { "description": "The Commit SHA.", "type": "string" }, "state": { "description": "The new state. Can be `pending`, `success`, `failure`, or `error`.", "type": "string", "enum": ["pending", "success", "failure", "error"] }, "target_url": { "description": "The optional link added to the status.", "type": ["string", "null"] }, "updated_at": { "type": "string" } }, "required": [ "id", "sha", "name", "target_url", "context", "description", "state", "commit", "branches", "created_at", "updated_at", "repository", "sender" ] }, "webhook-sub-issues-parent-issue-added": { "title": "parent issue added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["parent_issue_added"] }, "parent_issue_id": { "description": "The ID of the parent issue.", "type": "number" }, "parent_issue": { "$ref": "#/components/schemas/issue" }, "parent_issue_repo": { "$ref": "#/components/schemas/repository" }, "sub_issue_id": { "description": "The ID of the sub-issue.", "type": "number" }, "sub_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": [ "action", "sub_issue_id", "sub_issue", "repository", "sender" ] }, "webhook-sub-issues-parent-issue-removed": { "title": "parent issue removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["parent_issue_removed"] }, "parent_issue_id": { "description": "The ID of the parent issue.", "type": "number" }, "parent_issue": { "$ref": "#/components/schemas/issue" }, "parent_issue_repo": { "$ref": "#/components/schemas/repository" }, "sub_issue_id": { "description": "The ID of the sub-issue.", "type": "number" }, "sub_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": [ "action", "sub_issue_id", "sub_issue", "repository", "sender" ] }, "webhook-sub-issues-sub-issue-added": { "title": "sub-issue added event", "type": "object", "properties": { "action": { "type": "string", "enum": ["sub_issue_added"] }, "sub_issue_id": { "description": "The ID of the sub-issue.", "type": "number" }, "sub_issue": { "$ref": "#/components/schemas/issue" }, "sub_issue_repo": { "$ref": "#/components/schemas/repository" }, "parent_issue_id": { "description": "The ID of the parent issue.", "type": "number" }, "parent_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": [ "action", "parent_issue_id", "parent_issue", "repository", "sender" ] }, "webhook-sub-issues-sub-issue-removed": { "title": "sub-issue removed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["sub_issue_removed"] }, "sub_issue_id": { "description": "The ID of the sub-issue.", "type": "number" }, "sub_issue": { "$ref": "#/components/schemas/issue" }, "sub_issue_repo": { "$ref": "#/components/schemas/repository" }, "parent_issue_id": { "description": "The ID of the parent issue.", "type": "number" }, "parent_issue": { "$ref": "#/components/schemas/issue" }, "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" } }, "required": [ "action", "parent_issue_id", "parent_issue", "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" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" } }, "required": ["team", "repository", "sender"] }, "webhooks_team_1": { "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", "null"] }, "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", "null"], "properties": { "description": { "description": "Description of the team", "type": ["string", "null"] }, "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"] }, "notification_setting": { "description": "Whether team members will receive notifications when their team is @mentioned", "type": "string", "enum": ["notifications_enabled", "notifications_disabled"] }, "repositories_url": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "url": { "description": "URL for the team", "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": ["enterprise", "organization"] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [37] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [42] } }, "required": [ "name", "id", "node_id", "slug", "description", "privacy", "notification_setting", "url", "html_url", "members_url", "repositories_url", "permission", "type" ] }, "permission": { "description": "Permission that the team will have for its repositories", "type": "string" }, "privacy": { "type": "string", "enum": ["open", "closed", "secret"] }, "notification_setting": { "description": "Whether team members will receive notifications when their team is @mentioned", "type": "string", "enum": ["notifications_enabled", "notifications_disabled"] }, "repositories_url": { "type": "string", "format": "uri" }, "slug": { "type": "string" }, "url": { "description": "URL for the team", "type": "string", "format": "uri" }, "type": { "description": "The ownership type of the team", "type": "string", "enum": ["enterprise", "organization"] }, "organization_id": { "type": "integer", "description": "Unique identifier of the organization to which this team belongs", "examples": [37] }, "enterprise_id": { "type": "integer", "description": "Unique identifier of the enterprise to which this team belongs", "examples": [42] } }, "required": ["name", "id"] }, "webhook-team-added-to-repository": { "title": "team added_to_repository event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } ] }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" } }, "required": ["action", "team", "organization"] }, "webhook-team-created": { "title": "team created event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } ] }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" } }, "required": ["action", "team", "organization", "sender"] }, "webhook-team-deleted": { "title": "team deleted event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } ] }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" } }, "required": ["action", "team", "organization"] }, "webhook-team-edited": { "title": "team edited event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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"] }, "notification_setting": { "type": "object", "properties": { "from": { "description": "The previous version of the team's notification setting 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" } ] }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" } }, "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"] }, "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" } ] }, "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", "null"] }, "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", "null"] }, "hooks_url": { "type": "string", "format": "uri" }, "html_url": { "type": "string", "format": "uri" }, "id": { "description": "Unique identifier of the repository", "type": "integer", "format": "int64" }, "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", "null"] }, "languages_url": { "type": "string", "format": "uri" }, "license": { "title": "License", "type": ["object", "null"], "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "spdx_id": { "type": "string" }, "url": { "type": ["string", "null"], "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", "null"], "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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": { "oneOf": [ { "type": "integer" }, { "type": "string", "format": "date-time" } ], "type": ["null", "integer", "string"] }, "releases_url": { "type": "string", "format": "uri-template" }, "role_name": { "type": ["string", "null"] }, "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" }, "team": { "$ref": "#/components/schemas/webhooks_team_1" } }, "required": ["action", "team", "organization", "sender"] }, "webhook-watch-started": { "title": "watch started event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" } }, "required": ["action", "repository", "sender"] }, "webhook-workflow-dispatch": { "title": "workflow_dispatch event", "type": "object", "properties": { "enterprise": { "$ref": "#/components/schemas/enterprise-webhooks" }, "inputs": { "type": ["object", "null"], "additionalProperties": true }, "installation": { "$ref": "#/components/schemas/simple-installation" }, "organization": { "$ref": "#/components/schemas/organization-simple-webhooks" }, "ref": { "type": "string" }, "repository": { "$ref": "#/components/schemas/repository-webhooks" }, "sender": { "$ref": "#/components/schemas/simple-user" }, "workflow": { "type": "string" } }, "required": ["inputs", "ref", "repository", "sender", "workflow"] }, "webhook-workflow-job-completed": { "title": "workflow_job completed event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "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", "null"] }, "conclusion": { "type": ["string", "null"], "enum": [ "success", "failure", null, "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-cloud@latest/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", "null"] }, "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", "null"] }, "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", "null"] }, "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", "null"] }, "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", "null"], "description": "The name of the current branch." }, "workflow_name": { "type": ["string", "null"], "description": "The name of the workflow." }, "steps": { "type": "array", "items": { "title": "Workflow Step", "type": "object", "properties": { "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"], "enum": [ "failure", "skipped", "success", "cancelled", null ] }, "name": { "type": "string" }, "number": { "type": "integer" }, "started_at": { "type": ["string", "null"] }, "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", "null"] } }, "name": { "type": "string" }, "node_id": { "type": "string" }, "run_attempt": { "type": "integer" }, "run_id": { "type": "integer" }, "run_url": { "type": "string" }, "runner_group_id": { "type": ["number", "null"] }, "runner_group_name": { "type": ["string", "null"] }, "runner_id": { "type": ["number", "null"] }, "runner_name": { "type": ["string", "null"] }, "started_at": { "type": "string" }, "status": { "type": "string" }, "head_branch": { "type": ["string", "null"], "description": "The name of the current branch." }, "workflow_name": { "type": ["string", "null"], "description": "The name of the workflow." }, "steps": { "type": "array", "items": { "type": ["object", "null"] } }, "url": { "type": "string" } }, "required": ["conclusion"] } ] }, "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"] }, "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" }, "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", "null"] }, "conclusion": { "type": ["string", "null"], "enum": ["success", "failure", null, "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-cloud@latest/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", "null"] }, "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", "null"] }, "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", "null"] }, "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", "null"] }, "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", "null"], "description": "The name of the current branch." }, "workflow_name": { "type": ["string", "null"], "description": "The name of the workflow." }, "steps": { "type": "array", "items": { "title": "Workflow Step", "type": "object", "properties": { "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"], "enum": [ "failure", "skipped", "success", null, "cancelled" ] }, "name": { "type": "string" }, "number": { "type": "integer" }, "started_at": { "type": ["string", "null"] }, "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", "null"] }, "conclusion": { "type": ["string", "null"] }, "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", "null"] }, "runner_group_name": { "type": ["string", "null"] }, "runner_id": { "type": ["number", "null"] }, "runner_name": { "type": ["string", "null"] }, "started_at": { "type": "string" }, "status": { "type": "string", "enum": ["in_progress", "completed", "queued"] }, "head_branch": { "type": ["string", "null"], "description": "The name of the current branch." }, "workflow_name": { "type": ["string", "null"], "description": "The name of the workflow." }, "steps": { "type": "array", "items": { "title": "Workflow Step", "type": "object", "properties": { "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"] }, "name": { "type": "string" }, "number": { "type": "integer" }, "started_at": { "type": ["string", "null"] }, "status": { "type": "string", "enum": [ "in_progress", "completed", "pending", "queued" ] } }, "required": [ "name", "status", "conclusion", "number", "started_at", "completed_at" ] } }, "url": { "type": "string" } }, "required": ["status", "steps"] } ] }, "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"] }, "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" }, "workflow_job": { "type": "object", "properties": { "check_run_url": { "type": "string", "format": "uri" }, "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"] }, "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", "null"] }, "runner_group_name": { "type": ["string", "null"] }, "runner_id": { "type": ["integer", "null"] }, "runner_name": { "type": ["string", "null"] }, "started_at": { "type": "string", "format": "date-time" }, "status": { "type": "string", "enum": ["queued", "in_progress", "completed", "waiting"] }, "head_branch": { "type": ["string", "null"], "description": "The name of the current branch." }, "workflow_name": { "type": ["string", "null"], "description": "The name of the workflow." }, "steps": { "type": "array", "items": { "title": "Workflow Step", "type": "object", "properties": { "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"], "enum": [ "failure", "skipped", "success", "cancelled", null ] }, "name": { "type": "string" }, "number": { "type": "integer" }, "started_at": { "type": ["string", "null"] }, "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"] }, "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" }, "workflow_job": { "type": "object", "properties": { "check_run_url": { "type": "string", "format": "uri" }, "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"] }, "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", "null"] }, "runner_group_name": { "type": ["string", "null"] }, "runner_id": { "type": ["integer", "null"] }, "runner_name": { "type": ["string", "null"] }, "started_at": { "type": "string", "format": "date-time" }, "head_branch": { "type": ["string", "null"], "description": "The name of the current branch." }, "workflow_name": { "type": ["string", "null"], "description": "The name of the workflow." }, "status": { "type": "string", "enum": ["queued", "in_progress", "completed", "waiting"] }, "steps": { "type": "array", "items": { "title": "Workflow Step", "type": "object", "properties": { "completed_at": { "type": ["string", "null"] }, "conclusion": { "type": ["string", "null"], "enum": [ "failure", "skipped", "success", "cancelled", null ] }, "name": { "type": "string" }, "number": { "type": "integer" }, "started_at": { "type": ["string", "null"] }, "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"] }, "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" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" }, "workflow_run": { "title": "Workflow Run", "type": "object", "required": [ "actor", "artifacts_url", "cancel_url", "check_suite_id", "check_suite_node_id", "check_suite_url", "conclusion", "created_at", "event", "head_branch", "head_commit", "head_repository", "head_sha", "html_url", "id", "jobs_url", "logs_url", "name", "node_id", "path", "previous_attempt_url", "pull_requests", "repository", "rerun_url", "run_attempt", "run_number", "run_started_at", "status", "triggering_actor", "updated_at", "url", "workflow_id", "workflow_url" ], "properties": { "actor": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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", "null"], "enum": [ "action_required", "cancelled", "failure", "neutral", "skipped", "stale", "success", "timed_out", "startup_failure", null ] }, "created_at": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "head_branch": { "type": ["string", "null"] }, "head_commit": { "title": "SimpleCommit", "type": "object", "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ], "properties": { "author": { "title": "Committer", "description": "Metaproperties for Git author/committer information.", "type": "object", "required": ["email", "name"], "properties": { "date": { "type": "string", "format": "date-time" }, "email": { "type": ["string", "null"], "format": "email" }, "name": { "description": "The git author's name.", "type": "string" }, "username": { "type": "string" } } }, "committer": { "title": "Committer", "description": "Metaproperties for Git author/committer information.", "type": "object", "required": ["email", "name"], "properties": { "date": { "type": "string", "format": "date-time" }, "email": { "type": ["string", "null"], "format": "email" }, "name": { "description": "The git author's name.", "type": "string" }, "username": { "type": "string" } } }, "id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string" }, "tree_id": { "type": "string" } } }, "head_repository": { "title": "Repository Lite", "type": "object", "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" ], "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", "null"] }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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" } } }, "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", "null"] }, "node_id": { "type": "string" }, "path": { "type": "string" }, "previous_attempt_url": { "type": ["string", "null"], "format": "uri" }, "pull_requests": { "type": "array", "items": { "type": ["object", "null"], "required": ["url", "id", "number", "head", "base"], "properties": { "base": { "type": "object", "required": ["ref", "sha", "repo"], "properties": { "ref": { "type": "string" }, "repo": { "title": "Repo Ref", "type": "object", "required": ["id", "url", "name"], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "sha": { "type": "string" } } }, "head": { "type": "object", "required": ["ref", "sha", "repo"], "properties": { "ref": { "type": "string" }, "repo": { "title": "Repo Ref", "type": "object", "required": ["id", "url", "name"], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "sha": { "type": "string" } } }, "id": { "type": "number" }, "number": { "type": "number" }, "url": { "type": "string", "format": "uri" } } } }, "referenced_workflows": { "type": ["array", "null"], "items": { "type": "object", "required": ["path", "sha"], "properties": { "path": { "type": "string" }, "ref": { "type": "string" }, "sha": { "type": "string" } } } }, "repository": { "title": "Repository Lite", "type": "object", "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" ], "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", "null"] }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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" } } }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } } }, "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", "description": "The event-specific title associated with the run or the run-name if set, or the value of `run-name` if it is set in the workflow.", "examples": ["Simple Workflow"] } } } }, "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"] }, "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" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" }, "workflow_run": { "title": "Workflow Run", "type": "object", "required": [ "actor", "artifacts_url", "cancel_url", "check_suite_id", "check_suite_node_id", "check_suite_url", "conclusion", "created_at", "event", "head_branch", "head_commit", "head_repository", "head_sha", "html_url", "id", "jobs_url", "logs_url", "name", "node_id", "path", "previous_attempt_url", "pull_requests", "repository", "rerun_url", "run_attempt", "run_number", "run_started_at", "status", "triggering_actor", "updated_at", "url", "workflow_id", "workflow_url" ], "properties": { "actor": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "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", "null"], "enum": [ "action_required", "cancelled", "failure", "neutral", "skipped", "stale", "success", "timed_out", null ] }, "created_at": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "head_branch": { "type": ["string", "null"] }, "head_commit": { "title": "SimpleCommit", "type": "object", "required": [ "id", "tree_id", "message", "timestamp", "author", "committer" ], "properties": { "author": { "title": "Committer", "description": "Metaproperties for Git author/committer information.", "type": "object", "required": ["email", "name"], "properties": { "date": { "type": "string", "format": "date-time" }, "email": { "type": ["string", "null"], "format": "email" }, "name": { "description": "The git author's name.", "type": "string" }, "username": { "type": "string" } } }, "committer": { "title": "Committer", "description": "Metaproperties for Git author/committer information.", "type": "object", "required": ["email", "name"], "properties": { "date": { "type": "string", "format": "date-time" }, "email": { "type": ["string", "null"], "format": "email" }, "name": { "description": "The git author's name.", "type": "string" }, "username": { "type": "string" } } }, "id": { "type": "string" }, "message": { "type": "string" }, "timestamp": { "type": "string" }, "tree_id": { "type": "string" } } }, "head_repository": { "title": "Repository Lite", "type": "object", "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" ], "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", "null"] }, "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", "null"] }, "node_id": { "type": "string" }, "notifications_url": { "type": "string", "format": "uri-template" }, "owner": { "title": "User", "type": ["object", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "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" } } }, "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", "null"] }, "node_id": { "type": "string" }, "path": { "type": "string" }, "previous_attempt_url": { "type": ["string", "null"], "format": "uri" }, "pull_requests": { "type": "array", "items": { "type": ["object", "null"], "required": ["url", "id", "number", "head", "base"], "properties": { "base": { "type": "object", "required": ["ref", "sha", "repo"], "properties": { "ref": { "type": "string" }, "repo": { "title": "Repo Ref", "type": "object", "required": ["id", "url", "name"], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "sha": { "type": "string" } } }, "head": { "type": "object", "required": ["ref", "sha", "repo"], "properties": { "ref": { "type": "string" }, "repo": { "title": "Repo Ref", "type": "object", "required": ["id", "url", "name"], "properties": { "id": { "type": "integer" }, "name": { "type": "string" }, "url": { "type": "string", "format": "uri" } } }, "sha": { "type": "string" } } }, "id": { "type": "number" }, "number": { "type": "number" }, "url": { "type": "string", "format": "uri" } } } }, "referenced_workflows": { "type": ["array", "null"], "items": { "type": "object", "required": ["path", "sha"], "properties": { "path": { "type": "string" }, "ref": { "type": "string" }, "sha": { "type": "string" } } } }, "repository": { "title": "Repository Lite", "type": "object", "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" ], "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", "null"] }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "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" } } }, "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", "null"], "required": ["login", "id"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" } } }, "updated_at": { "type": "string", "format": "date-time" }, "url": { "type": "string", "format": "uri" }, "workflow_id": { "type": "integer" }, "workflow_url": { "type": "string", "format": "uri" } } } }, "required": [ "action", "repository", "sender", "workflow", "workflow_run" ] }, "webhook-workflow-run-requested": { "title": "workflow_run requested event", "type": "object", "properties": { "action": { "type": "string", "enum": ["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" }, "workflow": { "$ref": "#/components/schemas/webhooks_workflow" }, "workflow_run": { "title": "Workflow Run", "type": "object", "properties": { "actor": { "title": "User", "type": ["object", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "enum": [ "success", "failure", "neutral", "cancelled", "timed_out", "action_required", "stale", null, "skipped", "startup_failure" ] }, "created_at": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "head_branch": { "type": ["string", "null"] }, "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", "null"], "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", "null"], "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", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"] }, "node_id": { "type": "string" }, "path": { "type": "string" }, "previous_attempt_url": { "type": ["string", "null"], "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", "null"], "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", "null"] }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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", "null"], "properties": { "avatar_url": { "type": "string", "format": "uri" }, "deleted": { "type": "boolean" }, "email": { "type": ["string", "null"] }, "events_url": { "type": "string", "format": "uri-template" }, "followers_url": { "type": "string", "format": "uri" }, "following_url": { "type": "string", "format": "uri-template" }, "gists_url": { "type": "string", "format": "uri-template" }, "gravatar_id": { "type": "string" }, "html_url": { "type": "string", "format": "uri" }, "id": { "type": "integer" }, "login": { "type": "string" }, "name": { "type": "string" }, "node_id": { "type": "string" }, "organizations_url": { "type": "string", "format": "uri" }, "received_events_url": { "type": "string", "format": "uri" }, "repos_url": { "type": "string", "format": "uri" }, "site_admin": { "type": "boolean" }, "starred_url": { "type": "string", "format": "uri-template" }, "subscriptions_url": { "type": "string", "format": "uri" }, "type": { "type": "string", "enum": ["Bot", "User", "Organization"] }, "url": { "type": "string", "format": "uri" }, "user_view_type": { "type": "string" } }, "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" ] } }, "examples": { "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": null, "summary": null, "text": null, "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": null, "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": null, "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", "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", "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": null, "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": null, "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": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, "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": { "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": null, "started_at": "2019-05-15T15:21:12Z", "completed_at": null, "output": { "title": null, "summary": null, "text": null, "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": null, "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": null, "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", "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", "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": null, "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": null, "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": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, "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-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": null, "started_at": "2019-05-15T15:21:12Z", "completed_at": null, "output": { "title": null, "summary": null, "text": null, "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": null, "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", "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", "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": null, "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": null, "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": null, "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": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, "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-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": null, "summary": null, "text": null, "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": null, "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": null, "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", "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", "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": null, "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": null, "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": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, "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 } } }, "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": null, "status": "unused", "message": null } }, "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": null, "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": null, "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": null, "archived": false, "disabled": false, "open_issues_count": 0, "license": null, "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 } } }, "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": null, "resolved_at": null, "resolved_by": null, "secret_type": "mailchimp_api_key", "secret": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX-us2", "publicly_leaked": false, "multi_repo": false }, "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": null, "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": null, "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": null, "archived": false, "disabled": false, "open_issues_count": 2, "license": null, "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 } } } } } }