@octokit/openapi-webhooks

{ "openapi": "3.1.0", "info": { "version": "12.0.3", "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": "ghes", "x-github-release": 3.15 }, "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 GitHub Orgs." }, { "name": "packages", "description": "Manage packages for authenticated users and organizations." }, { "name": "projects", "description": "Interact with GitHub Projects." }, { "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": "Look for stuff 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": "scim", "description": "Provisioning of GitHub organization membership for SCIM-enabled providers." }, { "name": "enterprise-admin", "description": "Enterprise Administration" }, { "name": "oauth-authorizations", "description": "OAuth Authorizations API" }, { "name": "security-advisories", "description": "Security Advisories API" }, { "name": "code-security", "description": "Endpoints to manage code security using the REST API." } ], "servers": [ { "url": "{protocol}://{hostname}/api/v3", "variables": { "hostname": { "description": "Self-hosted Enterprise Server hostname", "default": "HOSTNAME" }, "protocol": { "description": "Self-hosted Enterprise Server protocol", "default": "http" } } } ], "externalDocs": { "description": "GitHub Enterprise Developer Docs", "url": "https://docs.github.com/enterprise-server@3.15/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-server@3.15/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-server@3.15/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "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-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-server@3.15/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-server@3.15/graphql/reference/objects#branchprotectionrule)\" in the GraphQL documentation or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "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-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-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "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 }, { "name": "X-GitHub-Enterprise-Version", "in": "header", "example": "3.1.9", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Enterprise-Host", "in": "header", "example": "ghes.github.com", "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-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "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 }, { "name": "X-GitHub-Enterprise-Version", "in": "header", "example": "3.1.9", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Enterprise-Host", "in": "header", "example": "ghes.github.com", "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-server@3.15/repositories/configuring-branches-and-merges-in-your-repository/defining-the-mergeability-of-pull-requests/about-protected-branches).\" For information about the APIs to manage branch protection rules, see [the GraphQL documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#branchprotectionrule) or \"[Branch protection](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "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 }, { "name": "X-GitHub-Enterprise-Version", "in": "header", "example": "3.1.9", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Enterprise-Host", "in": "header", "example": "ghes.github.com", "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-server@3.15/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-server@3.15/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": "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-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-server@3.15/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-server@3.15/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": "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-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-server@3.15/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-server@3.15/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": "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-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-server@3.15/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-server@3.15/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": "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-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-server@3.15/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-server@3.15/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": "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-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"] } } }, "cache-sync": { "post": { "summary": "This event occurs when a Git ref has been successfully synced to a cache replica. For more information, see \"[About repository caching](https://docs.github.com/enterprise-server@3.15/admin/enterprise-management/caching-repositories/about-repository-caching).\"", "operationId": "cache-sync", "externalDocs": { "url": "https://docs.github.com/enterprise-server@3.15/webhooks/webhook-events-and-payloads#cache_sync" }, "parameters": [ { "name": "User-Agent", "in": "header", "example": "GitHub-Hookshot/123abc", "schema": { "type": "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 }, { "name": "X-GitHub-Enterprise-Version", "in": "header", "example": "3.1.9", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Enterprise-Host", "in": "header", "example": "ghes.github.com", "schema": { "type": "string" }, "required": true } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook-cache-sync" } } } }, "responses": { "200": { "description": "Return a 200 status to indicate that the data was received successfully" } }, "x-github": { "githubCloudOnly": false, "category": "webhooks", "subcategory": "cache_sync", "supported-webhook-types": ["repository", "organization", "app"] } } }, "check-run-completed": { "post": { "summary": "This event occurs when there is activity relating to a check run. For information about check runs, see \"[Getting started with the Checks API](https://docs.github.com/enterprise-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "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 }, { "name": "X-GitHub-Enterprise-Version", "in": "header", "example": "3.1.9", "schema": { "type": "string" }, "required": true }, { "name": "X-GitHub-Enterprise-Host", "in": "header", "example": "ghes.github.com", "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-server@3.15/rest/guides/getting-started-with-the-checks-api).\" For information about the APIs to manage check runs, see [the GraphQL API documentation](https://docs.github.com/enterprise-server@3.15/graphql/reference/objects#checkrun) or \"[Check Runs](https://docs.github.com/enterprise-server@3.15/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-server@3.15/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": "issues", "schema": { "type": "string" }, "required": true }, { "name": "X-Github-Hook-Installation-Target-Id", "in": "header", "example": 123123, "schem